Source file caps.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
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
module Reply = Matrix_input.Reply
module Decoder = Matrix_input.Decoder
type t = {
colors : [ `Ansi16 | `Ansi256 | `Truecolor ];
dumb : bool;
eager_wrap : bool;
lifts_resting_cursor : bool;
kitty_keyboard : int option;
kitty_graphics : bool;
bracketed_paste : bool;
focus_tracking : bool;
unicode_width : Matrix_text.width_method;
grapheme_mode : bool option;
sgr_pixels : bool;
color_scheme_updates : bool;
explicit_width : bool;
explicit_cursor_positioning : bool;
scaled_text : bool;
sixel : bool;
graphics : [ `Kitty | `Sixel | `Blocks ];
sync : bool;
hyperlinks : bool;
notification : [ `Osc9 | `Osc777 ];
meta_sends_escape : bool option;
multiplexer : [ `Tmux | `Screen ] option;
identity : (string * string) option;
}
let defaults =
{
colors = `Ansi16;
dumb = false;
eager_wrap = false;
lifts_resting_cursor = false;
kitty_keyboard = None;
kitty_graphics = false;
bracketed_paste = false;
focus_tracking = false;
unicode_width = `Wcwidth;
grapheme_mode = None;
sgr_pixels = false;
color_scheme_updates = false;
explicit_width = false;
explicit_cursor_positioning = false;
scaled_text = false;
sixel = false;
graphics = `Blocks;
sync = false;
hyperlinks = false;
notification = `Osc9;
meta_sends_escape = None;
multiplexer = None;
identity = None;
}
let rec matches_at s sub i j m =
j = m || (s.[i + j] = sub.[j] && matches_at s sub i (j + 1) m)
let rec occurs_from s sub i n m =
i + m <= n && (matches_at s sub i 0 m || occurs_from s sub (i + 1) n m)
let contains s sub = occurs_from s sub 0 (String.length s) (String.length sub)
type env = {
term : string; (** Lowercase, [""] when unset. *)
colorterm : string;
term_program : (string * string) option;
kitty_window : bool;
termux : string option;
attached : bool;
(** No ssh session, multiplexer or zellij between the process and the
terminal its environment names. *)
tmux : bool;
screen : bool;
vhs : bool;
force_wcwidth : bool;
force_unicode : bool;
graphics : [ `Kitty | `Sixel | `Blocks ] option; (** [MATRIX_GRAPHICS]. *)
win32 : bool;
dumb : bool;
(** [TERM] unset, [dumb] or [unknown], outside a Windows console. *)
described : described;
styling : (string * string) list;
(** The variables of [Ansi.Styling.variables] that are set. *)
}
and described = {
direct_color : bool; (** [RGB], [Tc], or [setrgbf] and [setrgbb]. *)
palette : bool; (** [colors] of 256 or more. *)
eager : bool; (** [am] without [xenl]. *)
paste : bool; (** [BE]. *)
focus : bool; (** [fe]. *)
synchronized : bool; (** [Sync], as mode 2026. *)
}
let describe = function
| None ->
{
direct_color = false;
palette = false;
eager = false;
paste = false;
focus = false;
synchronized = false;
}
| Some t ->
let module T = Matrix_terminfo in
let has name = T.string t name <> None in
{
direct_color =
T.flag t "RGB"
|| T.number t "RGB" <> None
|| has "RGB" || T.flag t "Tc"
|| (has "setrgbf" && has "setrgbb");
palette =
(match T.number t "colors" with Some n -> n >= 256 | None -> false);
eager = T.flag t "am" && not (T.flag t "xenl");
paste = has "BE";
focus = has "fe";
synchronized =
(match T.string t "Sync" with
| Some s -> String.starts_with ~prefix:"\027[?2026" s
| None -> false);
}
let env ?terminfo getenv ~win32 =
let get name =
match getenv name with Some "" | None -> None | Some v -> Some v
in
let set name = Option.is_some (get name) in
let lower name =
String.lowercase_ascii (Option.value (get name) ~default:"")
in
let term = lower "TERM" in
let prefixed prefix = String.starts_with ~prefix term in
let tmux = set "TMUX" and screen = set "STY" in
{
term;
colorterm = lower "COLORTERM";
term_program =
Option.map
(fun name ->
(name, Option.value (get "TERM_PROGRAM_VERSION") ~default:""))
(get "TERM_PROGRAM");
kitty_window = set "KITTY_WINDOW_ID";
termux = get "TERMUX_VERSION";
attached =
not
(List.exists set [ "SSH_CONNECTION"; "SSH_CLIENT"; "SSH_TTY"; "ZELLIJ" ]
|| tmux || screen || prefixed "tmux" || prefixed "screen"
|| prefixed "zellij");
tmux;
screen;
vhs = set "VHS_RECORD";
force_wcwidth = set "MATRIX_FORCE_WCWIDTH";
force_unicode = set "MATRIX_FORCE_UNICODE";
graphics =
(match lower "MATRIX_GRAPHICS" with
| "kitty" -> Some `Kitty
| "sixel" -> Some `Sixel
| "blocks" -> Some `Blocks
| _ -> None);
win32;
dumb = (not win32) && List.mem term [ ""; "dumb"; "unknown" ];
described = describe terminfo;
styling =
List.filter_map
(fun name -> Option.map (fun v -> (name, v)) (get name))
Ansi.Styling.variables;
}
let no_env = { (env (fun _ -> None) ~win32:false) with dumb = false }
let variable env name = List.assoc_opt name env.styling
type evidence = {
env : env;
assumed : t;
modes : (int * Reply.setting) list; (** DECRPM of DEC modes, latest first. *)
keyboard : int option;
version : string option;
outer_version : string option;
(** The XTVERSION of the terminal outside tmux, through passthrough. *)
registers : int option; (** The sixel color registers (XTSMGRAPHICS). *)
attributes : int list option; (** The probe's DA1. *)
explicit : bool option;
scaled : bool option;
graphics : bool option;
passthrough : bool;
}
let make env assumed =
{
env;
assumed;
modes = [];
keyboard = None;
version = None;
outer_version = None;
registers = None;
attributes = None;
explicit = None;
scaled = None;
graphics = None;
passthrough = false;
}
let evidence env = make env defaults
let assume caps = make no_env caps
let add ev (r : Reply.t) =
match r with
| Mode { dec = true; mode; setting } ->
{ ev with modes = (mode, setting) :: List.remove_assoc mode ev.modes }
| Keyboard_flags flags -> { ev with keyboard = Some flags }
| Version text when ev.passthrough -> { ev with outer_version = Some text }
| Version text -> { ev with version = Some text }
| Csi { marker = Some '?'; final = 'S'; intermediates = ""; params }
when Ansi.Parser.Params.(value params 0 = Some 1 && value params 1 = Some 0)
->
{ ev with registers = Ansi.Parser.Params.value params 2 }
| Graphics { id = Some 31337; _ } -> { ev with graphics = Some true }
| _ -> ev
let parse_version text =
let text = String.trim text in
let cut i j = String.trim (String.sub text i (j - i)) in
let n = String.length text in
match String.index_opt text '(' with
| Some i ->
let j = Option.value (String.index_from_opt text i ')') ~default:n in
(cut 0 i, if j > i then cut (i + 1) j else "")
| None -> (
match String.index_opt text ' ' with
| Some i -> (cut 0 i, cut (i + 1) n)
| None -> (text, ""))
let major_minor version =
let n = String.length version in
let rec number i acc =
if i < n && version.[i] >= '0' && version.[i] <= '9' then
number (i + 1) ((acc * 10) + Char.code version.[i] - 48)
else (i, acc)
in
let rec start i =
if i >= n then None
else if version.[i] >= '0' && version.[i] <= '9' then
let i, major = number i 0 in
if i < n && version.[i] = '.' then
let j, minor = number (i + 1) 0 in
if j > i + 1 then Some (major, minor) else None
else None
else start (i + 1)
in
start 0
let at_least version v =
match major_minor version with Some mm -> mm >= v | None -> false
let decimal s =
if s <> "" && String.for_all (fun c -> c >= '0' && c <= '9') s then
int_of_string_opt s
else None
let ghostty_wide version =
let release =
match String.split_on_char '-' version with
| core :: suffix -> (
match String.split_on_char '.' core with
| [ major; minor; patch ] -> (
match (decimal major, decimal minor, decimal patch) with
| Some major, Some minor, Some patch ->
major > 1
|| (major = 1 && minor > 3)
|| major = 1 && minor = 3
&& (patch > 0
||
match suffix with
| [] -> true
| [ commits; revision ] ->
Option.is_some (decimal commits)
&& String.length revision > 1
&& revision.[0] = 'g'
&& String.for_all
(function
| '0' .. '9' | 'a' .. 'f' | 'A' .. 'F' -> true
| _ -> false)
(String.sub revision 1
(String.length revision - 1))
| _ -> false)
| _ -> false)
| _ -> false)
| [] -> false
in
release
|| String.starts_with ~prefix:"0.0.0-" version
&& String.length version > 14
&& version.[14] = '.'
&&
match decimal (String.sub version 6 8) with
| Some date -> date >= 20260224
| None -> false
let reported_identity ev =
match ev.version with
| Some text -> Some (parse_version text)
| None when ev.env.attached -> (
match (ev.env.term_program, ev.env.termux) with
| Some id, _ -> Some id
| None, _ when ev.env.kitty_window -> Some ("kitty", "")
| None, Some version -> Some ("termux", version)
| None, None -> None)
| None -> None
let env_multiplexer env =
if env.tmux then Some `Tmux
else if env.screen then Some `Screen
else if String.starts_with ~prefix:"tmux" env.term then Some `Tmux
else if String.starts_with ~prefix:"screen" env.term then Some `Screen
else None
let reported_multiplexer ev =
match ev.version with
| Some text ->
let name, _ = parse_version text in
if contains (String.lowercase_ascii name) "tmux" then Some `Tmux else None
| None -> env_multiplexer ev.env
let first options default =
match List.find_map Fun.id options with Some v -> v | None -> default
let when_ b v = if b then Some v else None
let supported : Reply.setting -> bool = function
| Set | Reset | Permanently_set -> true
| Not_recognized | Permanently_reset -> false
let modern_names = [ "ghostty"; "kitty"; "wezterm"; "alacritty"; "iterm" ]
let placeholders name version =
(contains name "kitty" && at_least version (0, 28)) || contains name "ghostty"
let derive ev =
let env = ev.env and d = ev.assumed in
let described = env.described in
let id = reported_identity ev in
let name, version =
match id with
| Some (name, version) -> (String.lowercase_ascii name, version)
| None -> ("", "")
in
let is family = contains name family in
let tmux = is "tmux" in
let modern = List.exists is modern_names in
let term_modern = List.exists (contains env.term) modern_names in
let truecolor =
env.colorterm = "truecolor" || env.colorterm = "24bit" || env.win32
in
let direct_term = String.ends_with ~suffix:"-direct" env.term in
let mux = reported_multiplexer ev in
let mode m = Option.map supported (List.assoc_opt m ev.modes) in
let sixel = first [ Option.map (List.mem 4) ev.attributes ] d.sixel in
let kitty_graphics =
first
[ when_ env.vhs false; ev.graphics; when_ (is "kitty") true ]
d.kitty_graphics
in
{
colors =
(if is "kitty" || truecolor || direct_term || described.direct_color then
`Truecolor
else if contains env.term "256color" || described.palette then `Ansi256
else d.colors);
dumb = env.dumb || d.dumb;
eager_wrap = (not env.win32) && (described.eager || d.eager_wrap);
lifts_resting_cursor =
is "wezterm" || contains env.term "wezterm" || d.lifts_resting_cursor;
kitty_keyboard =
(if env.vhs then None
else match ev.keyboard with Some _ as k -> k | None -> d.kitty_keyboard);
kitty_graphics;
bracketed_paste =
first
[
mode 2004;
when_ (is "kitty") true;
when_ tmux (at_least version (1, 7));
when_ env.win32 true;
when_ described.paste true;
]
d.bracketed_paste;
focus_tracking =
first
[
mode 1004;
when_ tmux (at_least version (1, 8));
when_ described.focus true;
]
d.focus_tracking;
unicode_width =
first
[
when_ env.force_unicode `Unicode;
when_ (env.force_wcwidth || env.vhs) `Wcwidth;
when_ (is "ghostty" && ghostty_wide version) `Unicode_wide;
(match List.assoc_opt 2027 ev.modes with
| Some (Set | Reset | Permanently_set) -> Some `Unicode
| Some Permanently_reset -> Some `Wcwidth
| Some Not_recognized | None -> None);
when_ (is "kitty") `Unicode;
when_ (tmux || is "apple_terminal" || is "termux") `Wcwidth;
when_ (Option.is_some mux) `Wcwidth;
when_ (contains env.term "kitty") `Unicode;
]
d.unicode_width;
grapheme_mode =
(match List.assoc_opt 2027 ev.modes with
| Some (Set | Permanently_set) -> Some true
| Some Reset -> Some false
| Some (Not_recognized | Permanently_reset) -> None
| None -> d.grapheme_mode);
sgr_pixels = first [ mode 1016 ] d.sgr_pixels;
color_scheme_updates = first [ mode 2031 ] d.color_scheme_updates;
explicit_width = first [ ev.explicit ] d.explicit_width;
explicit_cursor_positioning =
first
[ when_ (tmux || is "alacritty") true; when_ (Option.is_some mux) true ]
d.explicit_cursor_positioning;
scaled_text = first [ ev.scaled ] d.scaled_text;
sixel;
graphics =
first
[
env.graphics;
when_
(kitty_graphics
&& (placeholders name version
|| tmux
&&
match ev.outer_version with
| Some text ->
let name, version = parse_version text in
placeholders (String.lowercase_ascii name) version
| None -> false))
`Kitty;
when_
(sixel
&& (match ev.registers with Some n -> n >= 252 | None -> true)
&& not (is "konsole"))
`Sixel;
]
d.graphics;
sync =
first
[
mode 2026;
when_ tmux (at_least version (3, 7));
when_ modern true;
when_ term_modern true;
when_ described.synchronized true;
]
d.sync;
hyperlinks =
first
[ when_ (tmux || modern) true; when_ (term_modern || truecolor) true ]
d.hyperlinks;
notification =
(if String.starts_with ~prefix:"rxvt" env.term then `Osc777
else d.notification);
meta_sends_escape =
(match List.assoc_opt 1036 ev.modes with
| Some (Set | Permanently_set) -> Some true
| Some Reset -> Some false
| Some (Not_recognized | Permanently_reset) -> None
| None -> d.meta_sends_escape);
multiplexer =
(match (ev.version, mux) with
| Some _, mux | None, (Some _ as mux) -> mux
| None, None -> d.multiplexer);
identity = (match id with Some _ -> id | None -> d.identity);
}
type batch = Probe | Widths | Passthrough | Outer
let s7c1t = "\027 F"
let da1 = Ansi.(to_string (query Device_attributes))
let cursor_report = Ansi.(to_string (query Cursor_position))
let first_column = "\r"
let erase_below = "\027[J"
let graphics_query = Ansi.(to_string (query Kitty_graphics))
let wrap s = Ansi.(to_string (tmux_passthrough (literal s)))
let probe ~graphics =
String.concat ""
[
s7c1t;
Ansi.(to_string (query Sgr_pixels_mode));
Ansi.(to_string (query Unicode_mode));
Ansi.(to_string (query Color_scheme_mode));
Ansi.(to_string (query Focus_mode));
Ansi.(to_string (query Bracketed_paste_mode));
Ansi.(to_string (query Sync_mode));
"\027[?1036$p";
Ansi.(to_string (query Terminal_identity));
Ansi.(to_string (query Csi_u_support));
(if graphics then graphics_query else "");
"\027[16t";
"\027[?1;1;0S";
da1;
]
let widths =
String.concat ""
[
first_column;
Ansi.(to_string (query Explicit_width_support));
cursor_report;
first_column;
Ansi.(to_string (query Scaled_text_support));
cursor_report;
first_column;
erase_below;
]
let probe_graphics ev =
Option.is_none
(match env_multiplexer ev.env with
| Some _ as m -> m
| None -> ev.assumed.multiplexer)
let ask ev = function
| Probe ->
let graphics = probe_graphics ev in
( probe ~graphics,
{
Decoder.cursor_reports = 0;
string_replies = (if graphics then 2 else 1);
} )
| Widths -> (widths, { cursor_reports = 2; string_replies = 0 })
| Passthrough -> (wrap da1, { cursor_reports = 0; string_replies = 0 })
| Outer ->
( wrap graphics_query
^ wrap Ansi.(to_string (query Terminal_identity))
^ wrap da1,
{ cursor_reports = 0; string_replies = 2 } )
let cursor ev batch ~index ~row:_ ~col =
match (batch, index) with
| Widths, 0 -> { ev with explicit = Some (col = 1) }
| Widths, 1 ->
let scaled = col = 2 in
{
ev with
scaled = Some scaled;
explicit = (if scaled then Some true else ev.explicit);
}
| _ -> ev
let answered ev batch ~attributes =
let silent = function Some true -> Some true | _ -> Some false in
match batch with
| Probe ->
{
ev with
attributes = Some attributes;
graphics =
(if probe_graphics ev then silent ev.graphics else ev.graphics);
}
| Widths -> ev
| Passthrough -> { ev with passthrough = true }
| Outer -> { ev with graphics = silent ev.graphics }
let next ev = function
| Probe ->
if (derive ev).multiplexer = Some `Tmux then Some Passthrough else None
| Passthrough -> if ev.passthrough then Some Outer else None
| Widths | Outer -> None