Source file ctl_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
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
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
open! Cmdliner
open! Oxbow_core
open! Oxbow_ipc
let seat =
Arg.(
value
& opt (some string) None
& info
[ "seat" ]
~docv:"NAME"
~docs:Manpage.s_common_options
~doc:"Override primary-seat target")
;;
let socket = Cli.socket_arg
let enum_of to_string l = List.map (fun x -> to_string x, x) l
let mk_enum name ~doc ~docv l =
let open Cmdliner in
let doc = Printf.sprintf "%s The value is %s" doc (Arg.doc_alts_enum l) in
Arg.(value & opt (some (enum l)) None & info [ name ] ~docv ~doc)
;;
let spatial_targets = enum_of Direction.Spatial.to_string [ Up; Down; Left; Right ]
let logical_targets = enum_of Direction.Logical.to_string [ Next; Prev ]
let logical_leaves ~next ~prev =
List.map
(fun (name, (d : Oxbow_core.Direction.Logical.t)) ->
( name
, (match d with
| Next -> next
| Prev -> prev)
, d ))
logical_targets
;;
let direction_targets =
let open Direction in
List.map (fun (s, d) -> s, Logical d) logical_targets
@ List.map (fun (s, d) -> s, Spatial d) spatial_targets
;;
let delta_conv of_string pp =
let parser = function
| "" -> Error "empty delta"
| s when s.[0] = '+' || s.[0] = '-' ->
(match of_string s with
| Some n -> Ok (Delta.Rel n)
| None -> Error (Printf.sprintf "bad delta: %s" s))
| s ->
(match of_string s with
| Some n -> Ok (Delta.Abs n)
| None -> Error (Printf.sprintf "bad value: %s" s))
in
Arg.Conv.make ~docv:"DELTA" ~parser ~pp ()
;;
let int_delta_conv =
let pp ppf = function
| Delta.Abs n -> Format.fprintf ppf "%d" n
| Rel n -> Format.fprintf ppf "%+d" n
in
delta_conv int_of_string_opt pp
;;
let int_delta =
Arg.(
required
& pos 0 (some int_delta_conv) None
& info
[]
~docv:"INT_DELTA"
~doc:"May be either an absolute value ($(b,6)), or an offset ($(b,-2))")
;;
let float_delta_conv =
let pp ppf = function
| Delta.Abs n -> Format.fprintf ppf "%f" n
| Rel n -> Format.fprintf ppf "%+f" n
in
delta_conv float_of_string_opt pp
;;
let float_delta =
Arg.(
required
& pos 0 (some float_delta_conv) None
& info
[]
~docv:"FLOAT_DELTA"
~doc:"May be either an absolute value ($(b,0.55)), or an offset ($(b,-0.05))")
;;
let tag_arg_conv =
let parser s =
let s = String.trim s in
match s with
| "occupied" -> Ok Tag.Arg.Occupied
| s -> Result.map (fun t -> Tag.Arg.Concrete t) (Tag.Set.of_string s)
in
let pp ppf = function
| Tag.Arg.Occupied -> Format.fprintf ppf "occupied"
| Tag.Arg.Concrete t -> Format.fprintf ppf "%s" (Tag.Set.to_string t)
in
Arg.Conv.make ~docv:"TAGS" ~parser ~pp ()
;;
let tag_shared_doc =
"Tags are numbered 1 to 32. They may be named directly as indices: a single tag \
($(b,7)), a comma-separated list ($(b,1,3,8)), or a range ($(b,1-3,5)). They may also \
be given as a bitmask in hexadecimal ($(b,0xff)), binary ($(b,0b101)), or octal \
($(b,0o17)), where each set bit selects one tag. Note that $(b,7) means tag 7, while \
$(b,0b111) means tags 1, 2, and 3."
;;
let tag_arg =
let doc =
tag_shared_doc
^ " The string literal $(i,occupied) is allowed and represents all currently \
occupied tags."
in
Arg.(required & pos 0 (some tag_arg_conv) None & info [] ~docv:"TAGS" ~doc)
;;
let tag_set_conv =
let parser = Tag.Set.of_string in
let pp ppf t = Format.fprintf ppf "%s" @@ Tag.Set.to_string t in
Arg.Conv.make ~docv:"TAGS" ~parser ~pp ()
;;
let tag_set =
let doc = tag_shared_doc in
Arg.(required & pos 0 (some tag_set_conv) None & info [] ~docv:"TAGS" ~doc)
;;
let occupied_flag =
Arg.(value & flag & info [ "occupied" ] ~doc:"Restrict operation to occupied tags.")
;;
let policy_flag =
Arg.(
value
& vflag
Tag.Policy.Keep
[ ( Tag.Policy.Take
, info [ "take" ] ~doc:"Window takes the active tags on the destination output."
)
])
;;
let follow_flag =
Arg.(value & flag & info [ "follow" ] ~doc:"Move focus with the manipulated object")
;;
let ring_flag =
Arg.(
value
& opt (some (list string)) None
& info
[ "ring" ]
~docv:"OUTPUTS"
~doc:"Swap around the ring of comma-separated $(docv).")
;;
let rev_flag =
Arg.(value & flag & info [ "rev" ] ~doc:"Go around the ring in the reverse direction.")
;;
let swap_target =
let open Cmdliner.Term.Syntax in
Cmdliner.Term.term_result' ~usage:true
@@ let+ first = Arg.(value & pos 0 (some string) None & info [] ~docv:"SOURCE")
and+ second = Arg.(value & pos 1 (some string) None & info [] ~docv:"DESTINATION")
and+ ring = ring_flag
and+ rev = rev_flag in
match ring, first, rev with
| Some members, None, _ -> Ok (Command.Output.Swap.Target.Ring { members; rev })
| Some _, Some _, _ -> Error "--ring takes no OUTPUT positional"
| None, _, true -> Error "--rev needs --ring"
| None, _, false -> Ok (Command.Output.Swap.Target.Pair { first; second })
;;
let bind_swap_target =
let open Cmdliner.Term.Syntax in
Cmdliner.Term.term_result' ~usage:true
@@ let+ outputs = Arg.(value & pos_left ~rev:true 1 string [] & info [] ~docv:"OUTPUT")
and+ ring = ring_flag
and+ rev = rev_flag in
let pair first second = Command.Output.Swap.Target.Pair { first; second } in
match ring, outputs, rev with
| Some members, [], rev -> Ok (Command.Output.Swap.Target.Ring { members; rev })
| Some _, _ :: _, _ -> Error "--ring takes no OUTPUT positional"
| None, _, true -> Error "--rev needs --ring"
| None, [], false -> Ok (pair None None)
| None, [ a ], false -> Ok (pair (Some a) None)
| None, a :: b :: _, false -> Ok (pair (Some a) (Some b))
;;
let swap_terms mk =
let term target_t =
let open Cmdliner.Term.Syntax in
let+ target = target_t
and+ policy = policy_flag
and+ follow = follow_flag in
mk ~target ~policy ~follow
in
term swap_target, term bind_swap_target
;;
let app_id_flag =
Arg.(
value
& opt (some string) None
& info [ "app-id" ] ~docv:"REGEX" ~doc:"Match REGEX against the window's app-id.")
;;
let title_flag =
Arg.(
value
& opt (some string) None
& info [ "title" ] ~docv:"REGEX" ~doc:"Match REGEX against the window's title.")
;;
let identifier_flag =
Arg.(
value
& opt (some string) None
& info
[ "identifier" ]
~docv:"REGEX"
~doc:"Match REGEX against the window's identifier.")
;;
let label_flag =
Arg.(
value
& opt (some string) None
& info
[ "label" ]
~docv:"REGEX"
~doc:"Match REGEX against each of the window's labels.")
;;
let case_flag =
Arg.(
value
& vflag
Pattern.Case.Sensitive
[ ( Pattern.Case.Insensitive
, info [ "i"; "ignore-case" ] ~doc:"Match $(i,PATTERN) case-insensitively." )
])
;;
let device_pattern_flag =
Arg.(
value
& opt (some string) None
& info
[ "name" ]
~docv:"REGEX"
~doc:"Match $(docv), a PCRE regex, against the device name.")
;;
let invert_flag =
Arg.(value & flag & info [ "invert" ] ~doc:"Select the windows that do not match.")
;;
let output_name_arg =
Arg.(
required
& pos 0 (some string) None
& info
[]
~docv:"OUTPUT_NAME"
~doc:"The name of the target output, e.g., HDMI-A-2, eDP-1, etc.")
;;
let output_flag =
Arg.(
value
& opt (some string) None
& info [ "output" ] ~docv:"NAME" ~doc:"Filter to outputs matching $(i,NAME).")
;;
let output_query mk =
let open Cmdliner.Term.Syntax in
let+ output = output_flag in
mk output
;;
let extent_conv =
let parser = Extent.of_string in
let pp ppf e = Format.fprintf ppf "%s" @@ Extent.to_string e in
Arg.Conv.make ~docv:"EXTENT" ~parser ~pp ()
;;
let keybind_arg =
let open Cmdliner in
Arg.(
required
& pos ~rev:true 0 (some string) None
& info
[]
~docv:"KEYBIND"
~doc:
"Modifiers, keysym, and/or button. Modifiers include Shift, Control, Mod1/Alt, \
Mod3, Mod4/Super/Logo, Mod5, or None. Keysyms mirror xkbcommon-keysym.h \
without the 'K_' prefix, (e.g. Return instead of K_Return). Buttons are \
prefixed with 'Btn_' followed by [0-9], left, right, middle, side, extra, \
forward, back, or task.")
;;
let mode_flag =
let open Cmdliner in
Arg.(
value
& opt (some string) None
& info
[ "mode" ]
~docv:"MODE"
~doc:"The keymap mode the binding belongs to (default $(b,normal)).")
;;
let mode_name_arg =
Arg.(required & pos 0 (some string) None & info [] ~docv:"MODE" ~doc:"The mode name")
;;
let color_arg_conv =
let parser = Color.of_string in
let pp ppf c = Color.to_string c |> Format.fprintf ppf "%s" in
Arg.Conv.make ~docv:"COLOR" ~parser ~pp ()
;;
let color_arg =
Arg.(
required
& pos 0 (some color_arg_conv) None
& info
[]
~docv:"COLOR"
~doc:
"An RGBA or RGB color string. The following are equivalent: $(i,7FB4CAFF) \
$(i,7FB4CA). May be prefixed with $(i,#) or $(i,0x).")
;;
let index_arg ~doc = Arg.(required & pos 0 (some int) None & info [] ~docv:"INDEX" ~doc)
let index_args ~doc =
Arg.(
required
& pos 0 (some (list int)) None
& info
[]
~docv:"INDEX[,INDEX...]"
~doc:(doc ^ " May be a single index $(b,3) or a comma separated list $(b,2,3,5)."))
;;
let warp_flag =
Arg.(
value
& vflag
None
[ ( Some true
, info
[ "warp" ]
~doc:
"Warp the pointer after the focus change. This overrides the warp on \
focus configuration." )
; ( Some false
, info
[ "no-warp" ]
~doc:
"Do not warp the pointer after the focus change. This overrides the warp \
on focus configuration." )
])
;;
let pattern_flags =
let open Oxbow_core in
let open Cmdliner.Term.Syntax in
let+ title = title_flag
and+ app_id = app_id_flag
and+ identifier = identifier_flag
and+ label = label_flag
and+ case = case_flag in
({ title; app_id; identifier; label; case } : Window_pattern.t)
;;
let pattern_needed = "give at least one of --title, --app-id, --identifier, or --label"
let pattern_term =
let open Oxbow_core in
let open Cmdliner.Term.Syntax in
Cmdliner.Term.term_result' ~usage:true
@@ let+ p = pattern_flags in
if Window_pattern.is_empty p then Error pattern_needed else Ok p
;;
let scope_term =
let open Cmdliner.Term.Syntax in
Cmdliner.Term.term_result' ~usage:true
@@ let+ focused =
Arg.(value & flag & info [ "focused" ] ~doc:"Search the focused output only.")
and+ output = output_flag in
match focused, output with
| true, Some _ -> Error "--focused takes no --output"
| true, None -> Ok Scope.Focused
| false, Some name -> Ok (Scope.Output name)
| false, None -> Ok Scope.All
;;
let setting_scope_term =
let open Cmdliner.Term.Syntax in
Cmdliner.Term.term_result' ~usage:true
@@ let+ all =
Arg.(
value
& flag
& info
[ "all" ]
~doc:
"Apply the change to every tag on every output. The value becomes the \
default for new outputs and tags.")
and+ output = output_flag in
match all, output with
| true, Some _ -> Error "--all takes no --output"
| true, None -> Ok Scope.All
| false, Some name -> Ok (Scope.Output name)
| false, None -> Ok Scope.Focused
;;
let window_match_of source =
let open Oxbow_core in
let open Cmdliner.Term.Syntax in
let+ pattern = source
and+ invert = invert_flag
and+ scope = scope_term in
({ pattern; invert; scope } : Window_match.t)
;;
let window_match_term = window_match_of pattern_term
let window_match_any_term = window_match_of pattern_flags
let output_pattern_flags =
let open Oxbow_core in
let open Cmdliner.Term.Syntax in
let+ name =
Arg.(
value
& opt (some string) None
& info [ "name" ] ~docv:"REGEX" ~doc:"Match REGEX against the output's name.")
and+ label =
Arg.(
value
& opt (some string) None
& info
[ "label" ]
~docv:"REGEX"
~doc:"Match REGEX against each of the output's labels.")
and+ invert =
Arg.(value & flag & info [ "invert" ] ~doc:"Select the outputs that do not match.")
and+ case = case_flag in
({ name; label; case; invert } : Output_match.t)
;;
let select_one_flag =
let open Oxbow_core in
Arg.(
value
& vflag
Target.Select.Best
[ ( Target.Select.Cycle
, info [ "cycle" ] ~doc:"Act on the next match after the focused window." )
])
;;
let target_one_window_term =
let open Oxbow_core in
let open Cmdliner.Term.Syntax in
Cmdliner.Term.term_result' ~usage:true
@@ let+ wmatch = window_match_any_term
and+ select = select_one_flag in
if Window_pattern.is_empty wmatch.pattern
then (
match select with
| Best -> Ok Target.Window.One.Focused
| Cycle -> Error "--cycle needs a pattern")
else Ok (Matching { wmatch; select })
;;
let pick_any_flag =
Arg.(
value
& vflag
(`Select Target.Select.Best)
[ `All, info [ "all" ] ~doc:"Act on every match."
; ( `Select Target.Select.Cycle
, info [ "cycle" ] ~doc:"Act on the next match after the focused window" )
])
;;
let target_any_window_term =
let open Oxbow_core in
let open Cmdliner.Term.Syntax in
Cmdliner.Term.term_result' ~usage:true
@@ let+ wmatch = window_match_any_term
and+ pick = pick_any_flag in
if Window_pattern.is_empty wmatch.pattern
then (
match pick with
| `Select Best -> Ok (Target.Window.Any.One Focused)
| `All -> Error "--all needs a pattern"
| `Select Cycle -> Error "--cycle needs a pattern")
else (
match pick with
| `Select select -> Ok (One (Matching { wmatch; select }))
| `All -> Ok (All { wmatch }))
;;
let target_one_output_term =
let open Oxbow_core in
let open Cmdliner.Term.Syntax in
Cmdliner.Term.term_result' ~usage:true
@@ let+ omatch = output_pattern_flags
and+ select = select_one_flag in
if Output_match.is_empty omatch
then (
match select with
| Best -> Ok Target.Output.One.Focused
| Cycle -> Error "--cycle needs a pattern")
else Ok (Matching { omatch; select })
;;
let target_any_output_term =
let open Oxbow_core in
let open Cmdliner.Term.Syntax in
Cmdliner.Term.term_result' ~usage:true
@@ let+ omatch = output_pattern_flags
and+ pick = pick_any_flag in
if Output_match.is_empty omatch
then (
match pick with
| `Select Best -> Ok (Target.Output.Any.One Focused)
| `All -> Error "--all needs a pattern"
| `Select Cycle -> Error "--cycle needs a pattern")
else (
match pick with
| `Select select -> Ok (One (Matching { omatch; select }))
| `All -> Ok (All { omatch }))
;;
let tags_flag =
Arg.(
value
& opt (some tag_arg_conv) None
& info [ "tags" ] ~docv:"TAGS" ~doc:"Set TAGS on the matching windows.")
;;
let presentation_flag =
let open Oxbow_core.Window_rule.Effects.Presentation in
Arg.(
value
& vflag
None
[ Some Float, info [ "float" ] ~doc:"Manage the window floating."
; Some Tile, info [ "tile" ] ~doc:"Manage the window tiled."
; Some Fullscreen, info [ "fullscreen" ] ~doc:"Manage the window fullscreen."
; Some Windowed, info [ "windowed" ] ~doc:"Exit fullscreen."
; Some Maximize, info [ "maximize" ] ~doc:"Manage the window maximized."
; Some Fake_fullscreen, info [ "fake-fullscreen" ] ~doc:"Fake fullscreen."
])
;;
let extent_pair name ~docv ~doc =
Arg.(value & opt (some (list extent_conv)) None & info [ name ] ~docv ~doc)
;;
let extent_pos i ~docv ~doc =
Arg.(required & pos i (some extent_conv) None & info [] ~docv ~doc)
;;
let resize_to_flag =
let open Oxbow_core.Window_rule.Effects in
let open Cmdliner.Term.Syntax in
Cmdliner.Term.term_result' ~usage:true
@@ let+ pair =
extent_pair
"resize-to"
~docv:"W,H"
~doc:
"Resize the matching windows to $(i,W) and $(i,H). Each half is a pixel size \
(e.g. $(b,800)) or a percentage of the usable area (e.g. $(b,50%))."
in
match pair with
| None -> Ok None
| Some [ w; h ] -> Ok (Some ({ w; h } : Resize_to.t))
| Some _ -> Error "--resize-to takes two values: W,H"
;;
let move_to_flag =
let open Oxbow_core.Window_rule.Effects in
let open Cmdliner.Term.Syntax in
Cmdliner.Term.term_result' ~usage:true
@@ let+ pair =
extent_pair
"move-to"
~docv:"X,Y"
~doc:
"Move the matching windows to $(i,X) and $(i,Y). Each half is a pixel size \
(e.g. $(b,800)) or a percentage of the usable area (e.g. $(b,50%))."
in
match pair with
| None -> Ok None
| Some [ x; y ] -> Ok (Some ({ x; y } : Move_to.t))
| Some _ -> Error "--move-to takes two values: X,Y"
;;
let bool_state = Cmdliner.Arg.enum [ "enabled", true; "disabled", false ]
let bool_state_flag name ~doc ~docv =
Arg.(value & opt (some bool_state) None & info [ name ] ~docv ~doc)
;;
let accel_profile_flag =
mk_enum "accel-profile" ~doc:"Set the pointer acceleration profile." ~docv:"PROFILE"
@@ enum_of Input_rule.Accel_profile.to_string [ None; Flat; Adaptive; Custom ]
;;
let accel_speed_flag =
Arg.(
value
& opt (some float) None
& info
[ "accel-speed" ]
~docv:"SPEED"
~doc:"Set the pointer acceleration speed. The range is -1.0 to 1.0.")
;;
let button_map_flag name ~doc =
mk_enum name ~doc ~docv:"BUTTON" @@ enum_of Input_rule.Button_map.to_string [ Lrm; Lmr ]
;;
let drag_lock_flag =
mk_enum "drag-lock" ~doc:"Set the drag lock mode for tap-and-drag." ~docv:"OPTION"
@@ enum_of Input_rule.Drag_lock.to_string [ Disabled; Enabled_timeout; Enabled_sticky ]
;;
let three_finger_drag_flag =
mk_enum
"three-finger-drag"
~doc:"Set the drag gesture with three or four fingers."
~docv:"OPTION"
@@ enum_of Input_rule.Three_finger_drag.to_string [ Disabled; Enabled_3fg; Enabled_4fg ]
;;
let click_method_flag =
mk_enum "click-method" ~doc:"Set the click method of the touchpad." ~docv:"METHOD"
@@ enum_of Input_rule.Click_method.to_string [ None; Button_areas; Clickfinger ]
;;
let natural_scroll_flag =
bool_state_flag
"natural-scroll"
~doc:"Enable or disable the natural scroll direction."
~docv:"OPTION"
;;
let left_handed_flag =
bool_state_flag
"left-handed"
~doc:"Enable or disable the left-handed button layout."
~docv:"OPTION"
;;
let middle_emulation_flag =
bool_state_flag
"middle-emulation"
~doc:"Enable or disable middle-button emulation."
~docv:"OPTION"
;;
let scroll_factor_flag =
Arg.(
value
& opt (some float) None
& info
[ "scroll-factor" ]
~docv:"FACTOR"
~doc:"Multiply the scroll distance by $(docv).")
;;
let scroll_method_flag =
mk_enum "scroll-method" ~doc:"Set the scroll method of the device." ~docv:"METHOD"
@@ enum_of
Input_rule.Scroll_method.to_string
[ No_scroll; Two_finger; Edge; On_button_down ]
;;
let scroll_button_flag =
mk_enum
"scroll-button"
~doc:"Set the button that starts on-button-down scroll."
~docv:"BUTTON"
@@ enum_of Pointer_button.to_string Pointer_button.all
;;
let send_events_flag =
mk_enum "send-events" ~doc:"Set the send-events mode of the device." ~docv:"OPTION"
@@ enum_of
Input_rule.Send_events.to_string
[ Enabled; Disabled; Disabled_on_external_mouse ]
;;
let touchpad_rule =
let open Cmdliner.Term.Syntax in
Term.term_result' ~usage:true
@@ let+ pattern = device_pattern_flag
and+ case = case_flag
and+ tap =
bool_state_flag "tap" ~doc:"Enable or disable tap-to-click." ~docv:"OPTION"
and+ tap_button_map =
button_map_flag
"tap-button-map"
~doc:"Set the button order for taps with one, two, or three fingers."
and+ drag =
bool_state_flag "drag" ~doc:"Enable or disable tap-and-drag." ~docv:"OPTION"
and+ drag_lock = drag_lock_flag
and+ three_finger_drag = three_finger_drag_flag
and+ dwt =
bool_state_flag
"disable-while-typing"
~doc:"Enable or disable the disable-while-typing feature."
~docv:"OPTION"
and+ dwtp =
bool_state_flag
"disable-while-trackpointing"
~doc:"Enable or disable the disable-while-trackpointing feature."
~docv:"OPTION"
and+ click_method = click_method_flag
and+ clickfinger_button_map =
button_map_flag
"clickfinger-button-map"
~doc:"Set the button order for clicks with one, two, or three fingers."
and+ accel_profile = accel_profile_flag
and+ accel_speed = accel_speed_flag
and+ natural_scroll = natural_scroll_flag
and+ left_handed = left_handed_flag
and+ middle_emulation = middle_emulation_flag
and+ scroll_method = scroll_method_flag
and+ send_events = send_events_flag
and+ scroll_factor = scroll_factor_flag in
let settings =
Input_rule.Touchpad.
{ tap
; tap_button_map
; drag
; drag_lock
; three_finger_drag
; dwt
; dwtp
; click_method
; clickfinger_button_map
; accel_profile
; accel_speed
; natural_scroll
; left_handed
; middle_emulation
; scroll_method
; send_events
; scroll_factor
}
in
if settings = Input_rule.Touchpad.empty
then Error "give at least one setting flag"
else Ok ({ pattern; case; settings } : Input_rule.Touchpad.t Input_rule.rule)
;;
let mouse_rule =
let open Cmdliner in
let open Cmdliner.Term.Syntax in
Term.term_result' ~usage:true
@@ let+ pattern = device_pattern_flag
and+ case = case_flag
and+ accel_profile = accel_profile_flag
and+ accel_speed = accel_speed_flag
and+ natural_scroll = natural_scroll_flag
and+ left_handed = left_handed_flag
and+ middle_emulation = middle_emulation_flag
and+ scroll_method = scroll_method_flag
and+ scroll_button = scroll_button_flag
and+ scroll_button_lock =
bool_state_flag
"scroll-button-lock"
~doc:
"Enable or disable the scroll button lock. With the lock, the scroll button \
toggles, and you do not hold it."
~docv:"OPTION"
and+ send_events = send_events_flag
and+ scroll_factor = scroll_factor_flag in
let settings =
Input_rule.Mouse.
{ accel_profile
; accel_speed
; natural_scroll
; left_handed
; middle_emulation
; scroll_method
; scroll_button
; scroll_button_lock
; send_events
; scroll_factor
}
in
if settings = Input_rule.Mouse.empty
then Error "give at least one setting flag"
else Ok ({ pattern; case; settings } : Input_rule.Mouse.t Input_rule.rule)
;;
let sticky_flag =
mk_enum "sticky" ~doc:"Set the sticky state of the window." ~docv:"OPTION"
@@ enum_of Sticky.to_string Sticky.all
;;
let label_conv =
let parser = function
| "" -> Error "label must not be empty"
| s -> Ok s
in
Arg.Conv.make ~docv:"LABEL" ~parser ~pp:Format.pp_print_string ()
;;
let label_arg =
let open Cmdliner in
Arg.(required & pos 0 (some label_conv) None & info [] ~doc:"The label")
;;
let swallow_flag =
mk_enum "swallow" ~doc:"Set the swallow role of the window." ~docv:"ROLE"
@@ enum_of Swallow_role.to_string Swallow_role.all
;;
let label_as_flag =
let open Cmdliner in
Arg.(
value
& opt (some label_conv) None
& info [ "label-as" ] ~doc:"Add LABEL to matching windows.")
;;
let scratchpad_flag =
let open Cmdliner in
Arg.(
value
& opt (some string) None
& info [ "scratchpad" ] ~doc:"Set the scratchpad group to NAME." ~docv:"NAME")
;;
let spawn_position_flag =
mk_enum "spawn-position" ~doc:"Set the stack position of the window." ~docv:"POSITION"
@@ enum_of Spawn_position.to_string Spawn_position.all
;;
let spawn_focus_flag =
bool_state_flag
"spawn-focus"
~doc:"When enabled, the window takes focus on spawn."
~docv:"OPTION"
;;
let code_protocol_err = 1
let code_conn_failed = 2
let exit_success = Cmd.Exit.info 0 ~doc:"on success"
let exit_protocol_err =
Cmd.Exit.info code_protocol_err ~doc:"on protocol error from oxbow"
;;
let exit_conn_failed =
Cmd.Exit.info code_conn_failed ~doc:"on failure to connect to the oxbow socket"
;;
let exits = [ exit_success; exit_protocol_err; exit_conn_failed ]
let json_flag = Arg.(value & flag & info [ "json" ] ~doc:"Print the raw JSON reply.")
let rec flat (j : Yojson.Safe.t) =
match j with
| `Assoc fields ->
List.map (fun (key, value) -> Printf.sprintf "%s=%s" key (flat value)) fields
|> String.concat " "
| `List [ `String tag; payload ] -> tag ^ " " ^ flat payload
| `List [ `String tag ] | `String tag -> tag
| `List items -> List.map flat items |> String.concat ","
| `Bool _ | `Int _ | `Intlit _ | `Float _ | `Null -> Yojson.Safe.to_string j
;;
let render_event line =
try Yojson.Safe.from_string line |> flat with
| Yojson.Json_error _ -> line
;;
let render_lines ?(fields = []) ~expand (json : Yojson.Safe.t) =
let cap s =
if expand then s else if String.length s <= 15 then s else String.sub s 0 12 ^ "..."
in
let key =
String.uppercase_ascii key |> String.map (fun c -> if c = '_' then '-' else c)
in
let columns rows =
if fields <> []
then fields
else
List.fold_left
(fun acc row ->
List.fold_left
(fun acc (key, _) -> if List.mem key acc then acc else key :: acc)
acc
row)
[]
rows
|> List.rev
in
let cells cols rows =
List.map
(fun row ->
List.map
(fun col ->
match List.assoc_opt col row |> Option.value ~default:(`String "") with
| `Assoc _ as record -> flat record
| scalar -> flat scalar |> cap)
cols)
rows
in
let widths cols cells =
List.mapi
(fun i col ->
List.fold_left
(fun acc row -> List.nth row i |> String.length |> max acc)
(header col |> String.length)
cells)
cols
in
let to_row = function
| `Assoc row -> Some row
| `List [ `String tag; `Assoc row ] -> Some (("kind", `String tag) :: row)
| _ -> None
in
let rtrim s =
let n = ref (String.length s) in
while !n > 0 && s.[!n - 1] = ' ' do
decr n
done;
String.sub s 0 !n
in
let render_table rows =
let cols = columns rows in
let cs = cells cols rows in
let ws = widths cols cs in
let line entries =
List.map2 (fun w e -> Printf.sprintf "%-*s" w e) ws entries
|> String.concat " "
|> rtrim
in
(List.map header cols |> line) :: List.map line cs |> String.concat "\n"
in
match json with
| `List (_ :: _ as items) ->
(match List.filter_map to_row items with
| [] -> Yojson.Safe.to_string json
| rows -> render_table rows)
| `Assoc row -> render_table [ row ]
| _ -> Yojson.Safe.to_string json
;;
let dispatch_command ?render ?seat ?socket body =
Eio_posix.run
@@ fun env ->
match Client.send ~env ?seat ?socket body with
| Ok (Some (`String s)) ->
print_endline s;
Cmd.Exit.ok
| Ok (Some data) ->
let text =
match render with
| None -> Yojson.Safe.to_string data
| Some render -> render data
in
print_endline text;
Cmd.Exit.ok
| Ok None -> Cmd.Exit.ok
| Error (Connection_failed msg) ->
(Logs.err @@ fun m -> m "connection failed: %s" msg);
code_conn_failed
| Error (Protocol msg) ->
(Logs.err @@ fun m -> m "%s" msg);
code_protocol_err
;;
let dispatch_command_ref = ref dispatch_command
let dispatch_stream ?socket ?output ~human ~kinds () =
Eio_posix.run
@@ fun env ->
Sys.set_signal Sys.sigpipe Sys.Signal_default;
let emit line = print_endline (if human then render_event line else line) in
match
Client.subscribe ~env ?socket ?output ~kinds (fun line ->
emit line;
flush stdout)
with
| Ok () -> Cmd.Exit.ok
| Error (Connection_failed msg) ->
(Logs.err @@ fun m -> m "connection failed: %s" msg);
code_conn_failed
| Error (Protocol msg) ->
(Logs.err @@ fun m -> m "%s" msg);
code_protocol_err
;;
let dispatch_stream_ref = ref dispatch_stream
let group ?(exits = exits) = Cli.group ~exits
let run_term term =
let open Cmdliner.Term.Syntax in
let+ seat = seat
and+ socket = socket
and+ body, render = term in
!dispatch_command_ref ?render ?seat ?socket body
;;
let cmd ~name ~doc term = Cli.cmd ~exits ~name ~doc (run_term term)
let human_flag =
Arg.(
value
& flag
& info [ "h"; "human" ] ~doc:"Render each event as one flat key=value line.")
;;
let stream_cmd ~name ~doc term =
let open Cmdliner.Term.Syntax in
Cli.cmd ~exits ~name ~doc
@@
let+ socket = socket
and+ human = human_flag
and+ kinds, output = term in
!dispatch_stream_ref ?socket ?output ~human ~kinds ()
;;
let command_term term =
let open Cmdliner.Term.Syntax in
let+ command = term in
Request.Body.Command command, None
;;
let bind_to_kw =
let to_kw = Arg.enum [ "to", () ] in
Arg.(
required
& pos ~rev:true 1 (some to_kw) None
& info [] ~docv:"to" ~doc:"Literal $(b,to) separating command from keybind")
;;
let bind_suffix =
let open Cmdliner.Term.Syntax in
let+ () = bind_to_kw
and+ keybind = keybind_arg in
keybind
;;
let bind_term term =
let open Cmdliner.Term.Syntax in
let+ command = term
and+ mode = mode_flag
and+ keybind = bind_suffix in
Request.Body.Keymap (Bind { keybind; command; mode }), None
;;
let bind_to_term term =
let open Cmdliner.Term.Syntax in
let t =
let+ command = term
and+ mode = mode_flag
and+ keybind = keybind_arg in
Request.Body.Keymap (Bind { keybind; command; mode }), None
in
cmd ~name:"to" ~doc:"Bind this command to $(i,KEYBIND)" t
;;
let cmd_pair ?bind ~name ~doc term =
let bind = Option.value bind ~default:term in
cmd ~name ~doc (command_term term), cmd ~name ~doc (bind_term bind)
;;
let group_pair ?( = []) ?default ~name ~doc pairs =
let cmds, binds = List.split pairs in
let mk mk_term children =
group
~name
~doc
?default:(Option.map (fun t -> run_term (mk_term t)) default)
children
in
let to_child =
match default with
| None -> []
| Some t -> [ bind_to_term t ]
in
mk command_term (cmds @ extra), mk bind_term (binds @ to_child)
;;
let expand_flag =
Arg.(value & flag & info [ "expand" ] ~doc:"Do not truncate cell values.")
;;
let fields_flag =
Arg.(
value
& opt (list string) []
& info [ "fields" ] ~doc:"Comma-separated list of columns to show." ~docv:"FIELDS")
;;
let query_term ?render term =
let open Cmdliner.Term.Syntax in
let+ json = json_flag
and+ expand = expand_flag
and+ fields = fields_flag
and+ query = term in
( Request.Body.Query query
, if json then None else Option.map (fun r -> r ?fields:(Some fields) ~expand) render )
;;
let const_leaves l =
List.map (fun (name, doc, c) -> cmd_pair ~name ~doc (Cmdliner.Term.const c)) l
;;