package wayland

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file tablet_v2_server.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
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
(* This file was generated automatically by wayland-scanner-ocaml *)

[@@@ocaml.warning "-27-34"]
open struct
  module Imports = struct
    include Tablet_v2_proto
    include Wayland.Wayland_proto
  end
  
  module Proxy = Wayland.Proxy
  module Msg = Wayland.Msg
  module Fixed = Wayland.Fixed
  module Iface_reg = Wayland.Iface_reg
  module S = Wayland.S
end


(** Controller object for graphic tablet devices.
    
    An object that provides access to the graphics tablets available on this
    system. All tablets are associated with a seat, to get access to the
    actual tablets, use wp_tablet_manager.get_tablet_seat. *)
module Zwp_tablet_manager_v2 = struct
  type 'v t = ([`Zwp_tablet_manager_v2], 'v, [`Server]) Proxy.t
  
  (** {2 Version 1} *)
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_manager_v2)
    method max_version = 1l
    
    method private virtual on_get_tablet_seat : [> ] t -> ([`Zwp_tablet_seat_v2], 'v, [`Server]) Proxy.t ->
                                                seat:([`Wl_seat], [> Imports.Wl_seat.versions], [`Server]) Proxy.t ->
                                                unit
    
    method private virtual on_destroy : [> ] t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let tablet_seat : ([`Zwp_tablet_seat_v2], _, _) Proxy.t =
          Msg.get_int _msg |> Proxy.Handler.accept_new _proxy (module Imports.Zwp_tablet_seat_v2) in
        let seat : ([`Wl_seat], _, _) Proxy.t =
          let Proxy.Proxy p = Msg.get_int _msg |> Proxy.lookup_other _proxy in
          match Proxy.ty p with
          | Imports.Wl_seat.T -> p
          | _ -> Proxy.wrong_type ~parent:_proxy ~expected:"wl_seat" p
          in
        _self#on_get_tablet_seat _proxy tablet_seat ~seat
      | 1 ->
        Proxy.shutdown_recv _proxy;
        _self#on_destroy _proxy 
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_get_tablet_seat : [> `V1] t -> ([`Zwp_tablet_seat_v2], 'v, [`Server]) Proxy.t ->
                                                seat:([`Wl_seat], [> Imports.Wl_seat.versions], [`Server]) Proxy.t ->
                                                unit
    
    (** Get the tablet seat.
        
        Get the wp_tablet_seat object for the given seat. This object
        provides access to all graphics tablets in this seat. *)
    
    method private virtual on_destroy : [> `V1] t -> unit
    
    (** Release the memory for the tablet manager object.
        
        Destroy the wp_tablet_manager object. Objects created from this
        object are unaffected and should be destroyed separately. *)
    
    method min_version = 1l
    method bind_version : [`V1] = `V1
  end
end

(** Controller object for graphic tablet devices of a seat.
    
    An object that provides access to the graphics tablets available on this
    seat. After binding to this interface, the compositor sends a set of
    wp_tablet_seat.tablet_added and wp_tablet_seat.tool_added events. *)
module Zwp_tablet_seat_v2 = struct
  type 'v t = ([`Zwp_tablet_seat_v2], 'v, [`Server]) Proxy.t
  
  (** {2 Version 1} *)
  
  (** New pad notification.
      
      This event is sent whenever a new pad is known to the system. Typically,
      pads are physically attached to tablets and a pad_added event is
      sent immediately after the wp_tablet_seat.tablet_added.
      However, some standalone pad devices logically attach to tablets at
      runtime, and the client must wait for wp_tablet_pad.enter to know
      the tablet a pad is attached to.
      
      This event only provides the object id of the pad. All further
      features (buttons, strips, rings) are sent through the wp_tablet_pad
      interface. *)
  let pad_added (_t:([< `V1] as 'v) t) (id:([`Zwp_tablet_pad_v2], 'v, [`Server]) #Proxy.Handler.t) =
    let __id = Proxy.spawn _t id in
    let _msg = Proxy.alloc _t ~op:2 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Proxy.id __id);
    Proxy.send _t _msg;
    __id
  
  (** A new tool has been used with a tablet.
      
      This event is sent whenever a tool that has not previously been used
      with a tablet comes into use. This event only provides the object id
      of the tool; any static information about the tool (capabilities,
      type, etc.) is sent through the wp_tablet_tool interface. *)
  let tool_added (_t:([< `V1] as 'v) t) (id:([`Zwp_tablet_tool_v2], 'v, [`Server]) #Proxy.Handler.t) =
    let __id = Proxy.spawn _t id in
    let _msg = Proxy.alloc _t ~op:1 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Proxy.id __id);
    Proxy.send _t _msg;
    __id
  
  (** New device notification.
      
      This event is sent whenever a new tablet becomes available on this
      seat. This event only provides the object id of the tablet, any
      static information about the tablet (device name, vid/pid, etc.) is
      sent through the wp_tablet interface. *)
  let tablet_added (_t:([< `V1] as 'v) t) (id:([`Zwp_tablet_v2], 'v, [`Server]) #Proxy.Handler.t) =
    let __id = Proxy.spawn _t id in
    let _msg = Proxy.alloc _t ~op:0 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Proxy.id __id);
    Proxy.send _t _msg;
    __id
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_seat_v2)
    method max_version = 1l
    
    method private virtual on_destroy : [> ] t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        Proxy.shutdown_recv _proxy;
        _self#on_destroy _proxy 
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_destroy : [> `V1] t -> unit
    
    (** Release the memory for the tablet seat object.
        
        Destroy the wp_tablet_seat object. Objects created from this
        object are unaffected and should be destroyed separately. *)
    
    method min_version = 1l
  end
end

(** A physical tablet tool.
    
    An object that represents a physical tool that has been, or is
    currently in use with a tablet in this seat. Each wp_tablet_tool
    object stays valid until the client destroys it; the compositor
    reuses the wp_tablet_tool object to indicate that the object's
    respective physical tool has come into proximity of a tablet again.
    
    A wp_tablet_tool object's relation to a physical tool depends on the
    tablet's ability to report serial numbers. If the tablet supports
    this capability, then the object represents a specific physical tool
    and can be identified even when used on multiple tablets.
    
    A tablet tool has a number of static characteristics, e.g. tool type,
    hardware_serial and capabilities. These capabilities are sent in an
    event sequence after the wp_tablet_seat.tool_added event before any
    actual events from this tool. This initial event sequence is
    terminated by a wp_tablet_tool.done event.
    
    Tablet tool events are grouped by wp_tablet_tool.frame events.
    Any events received before a wp_tablet_tool.frame event should be
    considered part of the same hardware state change. *)
module Zwp_tablet_tool_v2 = struct
  type 'v t = ([`Zwp_tablet_tool_v2], 'v, [`Server]) Proxy.t
  module Type = Tablet_v2_proto.Zwp_tablet_tool_v2.Type
  
  module Capability = Tablet_v2_proto.Zwp_tablet_tool_v2.Capability
  
  module Button_state = Tablet_v2_proto.Zwp_tablet_tool_v2.Button_state
  
  module Error = Tablet_v2_proto.Zwp_tablet_tool_v2.Error
  
  (** {2 Version 1} *)
  
  (** Frame event.
      
      Marks the end of a series of axis and/or button updates from the
      tablet. The Wayland protocol requires axis updates to be sent
      sequentially, however all events within a frame should be considered
      one hardware event. *)
  let frame (_t:([< `V1] as 'v) t) ~time =
    let _msg = Proxy.alloc _t ~op:18 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg time;
    Proxy.send _t _msg
  
  (** Button event.
      
      Sent whenever a button on the tool is pressed or released.
      
      If a button is held down when the tool moves in or out of proximity,
      button events are generated by the compositor. See
      wp_tablet_tool.proximity_in and wp_tablet_tool.proximity_out for
      details. *)
  let button (_t:([< `V1] as 'v) t) ~serial ~button ~state =
    let _msg = Proxy.alloc _t ~op:17 ~ints:3 ~strings:[] ~arrays:[] in
    Msg.add_int _msg serial;
    Msg.add_int _msg button;
    Msg.add_int _msg (Imports.Zwp_tablet_tool_v2.Button_state.to_int32 state);
    Proxy.send _t _msg
  
  (** Wheel delta event.
      
      Sent whenever the wheel on the tool emits an event. This event
      contains two values for the same axis change. The degrees value is
      in the same orientation as the wl_pointer.vertical_scroll axis. The
      clicks value is in discrete logical clicks of the mouse wheel. This
      value may be zero if the movement of the wheel was less
      than one logical click.
      
      Clients should choose either value and avoid mixing degrees and
      clicks. The compositor may accumulate values smaller than a logical
      click and emulate click events when a certain threshold is met.
      Thus, wl_tablet_tool.wheel events with non-zero clicks values may
      have different degrees values. *)
  let wheel (_t:([< `V1] as 'v) t) ~degrees ~clicks =
    let _msg = Proxy.alloc _t ~op:16 ~ints:2 ~strings:[] ~arrays:[] in
    Msg.add_fixed _msg degrees;
    Msg.add_int _msg clicks;
    Proxy.send _t _msg
  
  (** Slider position change event.
      
      Sent whenever the slider position on the tool changes. The
      value is normalized between -65535 and 65535, with 0 as the logical
      neutral position of the slider.
      
      The slider is available on e.g. the Wacom Airbrush tool. *)
  let slider (_t:([< `V1] as 'v) t) ~position =
    let _msg = Proxy.alloc _t ~op:15 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg position;
    Proxy.send _t _msg
  
  (** Z-rotation change event.
      
      Sent whenever the z-rotation axis on the tool changes. The
      rotation value is in degrees clockwise from the tool's
      logical neutral position. *)
  let rotation (_t:([< `V1] as 'v) t) ~degrees =
    let _msg = Proxy.alloc _t ~op:14 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_fixed _msg degrees;
    Proxy.send _t _msg
  
  (** Tilt change event.
      
      Sent whenever one or both of the tilt axes on a tool change. Each tilt
      value is in degrees, relative to the z-axis of the tablet.
      The angle is positive when the top of a tool tilts along the
      positive x or y axis. *)
  let tilt (_t:([< `V1] as 'v) t) ~tilt_x ~tilt_y =
    let _msg = Proxy.alloc _t ~op:13 ~ints:2 ~strings:[] ~arrays:[] in
    Msg.add_fixed _msg tilt_x;
    Msg.add_fixed _msg tilt_y;
    Proxy.send _t _msg
  
  (** Distance change event.
      
      Sent whenever the distance axis on a tool changes. The value of this
      event is normalized to a value between 0 and 65535.
      
      Note that distance may be nonzero even when a tool is not in logical
      contact. See the down and up events for more details. *)
  let distance (_t:([< `V1] as 'v) t) ~distance =
    let _msg = Proxy.alloc _t ~op:12 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg distance;
    Proxy.send _t _msg
  
  (** Pressure change event.
      
      Sent whenever the pressure axis on a tool changes. The value of this
      event is normalized to a value between 0 and 65535.
      
      Note that pressure may be nonzero even when a tool is not in logical
      contact. See the down and up events for more details. *)
  let pressure (_t:([< `V1] as 'v) t) ~pressure =
    let _msg = Proxy.alloc _t ~op:11 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg pressure;
    Proxy.send _t _msg
  
  (** Motion event.
      
      Sent whenever a tablet tool moves. *)
  let motion (_t:([< `V1] as 'v) t) ~x ~y =
    let _msg = Proxy.alloc _t ~op:10 ~ints:2 ~strings:[] ~arrays:[] in
    Msg.add_fixed _msg x;
    Msg.add_fixed _msg y;
    Proxy.send _t _msg
  
  (** Tablet tool is no longer making contact.
      
      Sent whenever the tablet tool stops making contact with the surface of
      the tablet, or when the tablet tool moves out of the input region
      and the compositor grab (if any) is dismissed.
      
      If the tablet tool moves out of the input region while in contact
      with the surface of the tablet and the compositor does not have an
      ongoing grab on the surface, the client owning said region will
      receive a wp_tablet.up event, followed by a wp_tablet.proximity_out
      event and a wp_tablet.frame event. If the compositor has an ongoing
      grab on this device, this event sequence is sent whenever the grab
      is dismissed in the future.
      
      Note that this event describes logical contact, not physical
      contact. On some devices, a compositor may not consider a tool out
      of logical contact until physical pressure falls below a specific
      threshold. *)
  let up (_t:([< `V1] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:9 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg
  
  (** Tablet tool is making contact.
      
      Sent whenever the tablet tool comes in contact with the surface of the
      tablet.
      
      If the tool is already in contact with the tablet when entering the
      input region, the client owning said region will receive a
      wp_tablet.proximity_in event, followed by a wp_tablet.down
      event and a wp_tablet.frame event.
      
      Note that this event describes logical contact, not physical
      contact. On some devices, a compositor may not consider a tool in
      logical contact until a minimum physical pressure threshold is
      exceeded. *)
  let down (_t:([< `V1] as 'v) t) ~serial =
    let _msg = Proxy.alloc _t ~op:8 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg serial;
    Proxy.send _t _msg
  
  (** Proximity out event.
      
      Notification that this tool has either left proximity, or is no
      longer focused on a certain surface.
      
      When the tablet tool leaves proximity of the tablet, button release
      events are sent for each button that was held down at the time of
      leaving proximity. These events are sent before the proximity_out
      event but within the same wp_tablet.frame.
      
      If the tool stays within proximity of the tablet, but the focus
      changes from one surface to another, a button release event may not
      be sent until the button is actually released or the tool leaves the
      proximity of the tablet. *)
  let proximity_out (_t:([< `V1] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:7 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg
  
  (** Proximity in event.
      
      Notification that this tool is focused on a certain surface.
      
      This event can be received when the tool has moved from one surface to
      another, or when the tool has come back into proximity above the
      surface.
      
      If any button is logically down when the tool comes into proximity,
      the respective button event is sent after the proximity_in event but
      within the same frame as the proximity_in event. *)
  let proximity_in (_t:([< `V1] as 'v) t) ~serial ~(tablet:([`Zwp_tablet_v2], _, [`Server]) Proxy.t) ~(surface:([`Wl_surface], _, [`Server]) Proxy.t) =
    let _msg = Proxy.alloc _t ~op:6 ~ints:3 ~strings:[] ~arrays:[] in
    Msg.add_int _msg serial;
    Msg.add_int _msg (Proxy.id tablet);
    Msg.add_int _msg (Proxy.id surface);
    Proxy.send _t _msg
  
  (** Tool removed.
      
      This event is sent when the tool is removed from the system and will
      send no further events. Should the physical tool come back into
      proximity later, a new wp_tablet_tool object will be created.
      
      It is compositor-dependent when a tool is removed. A compositor may
      remove a tool on proximity out, tablet removal or any other reason.
      A compositor may also keep a tool alive until shutdown.
      
      If the tool is currently in proximity, a proximity_out event will be
      sent before the removed event. See wp_tablet_tool.proximity_out for
      the handling of any buttons logically down.
      
      When this event is received, the client must wp_tablet_tool.destroy
      the object. *)
  let removed (_t:([< `V1] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:5 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg
  
  (** Tool description events sequence complete.
      
      This event signals the end of the initial burst of descriptive
      events. A client may consider the static description of the tool to
      be complete and finalize initialization of the tool. *)
  let done_ (_t:([< `V1] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:4 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg
  
  (** Tool capability notification.
      
      This event notifies the client of any capabilities of this tool,
      beyond the main set of x/y axes and tip up/down detection.
      
      One event is sent for each extra capability available on this tool.
      
      This event is sent in the initial burst of events before the
      wp_tablet_tool.done event. *)
  let capability (_t:([< `V1] as 'v) t) ~capability =
    let _msg = Proxy.alloc _t ~op:3 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Imports.Zwp_tablet_tool_v2.Capability.to_int32 capability);
    Proxy.send _t _msg
  
  (** Hardware id notification in Wacom's format.
      
      This event notifies the client of a hardware id available on this tool.
      
      The hardware id is a device-specific 64-bit id that provides extra
      information about the tool in use, beyond the wl_tool.type
      enumeration. The format of the id is specific to tablets made by
      Wacom Inc. For example, the hardware id of a Wacom Grip
      Pen (a stylus) is 0x802.
      
      This event is sent in the initial burst of events before the
      wp_tablet_tool.done event. *)
  let hardware_id_wacom (_t:([< `V1] as 'v) t) ~hardware_id_hi ~hardware_id_lo =
    let _msg = Proxy.alloc _t ~op:2 ~ints:2 ~strings:[] ~arrays:[] in
    Msg.add_int _msg hardware_id_hi;
    Msg.add_int _msg hardware_id_lo;
    Proxy.send _t _msg
  
  (** Unique hardware serial number of the tool.
      
      If the physical tool can be identified by a unique 64-bit serial
      number, this event notifies the client of this serial number.
      
      If multiple tablets are available in the same seat and the tool is
      uniquely identifiable by the serial number, that tool may move
      between tablets.
      
      Otherwise, if the tool has no serial number and this event is
      missing, the tool is tied to the tablet it first comes into
      proximity with. Even if the physical tool is used on multiple
      tablets, separate wp_tablet_tool objects will be created, one per
      tablet.
      
      This event is sent in the initial burst of events before the
      wp_tablet_tool.done event. *)
  let hardware_serial (_t:([< `V1] as 'v) t) ~hardware_serial_hi ~hardware_serial_lo =
    let _msg = Proxy.alloc _t ~op:1 ~ints:2 ~strings:[] ~arrays:[] in
    Msg.add_int _msg hardware_serial_hi;
    Msg.add_int _msg hardware_serial_lo;
    Proxy.send _t _msg
  
  (** Tool type.
      
      The tool type is the high-level type of the tool and usually decides
      the interaction expected from this tool.
      
      This event is sent in the initial burst of events before the
      wp_tablet_tool.done event. *)
  let type_ (_t:([< `V1] as 'v) t) ~tool_type =
    let _msg = Proxy.alloc _t ~op:0 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Imports.Zwp_tablet_tool_v2.Type.to_int32 tool_type);
    Proxy.send _t _msg
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_tool_v2)
    method max_version = 1l
    
    method private virtual on_set_cursor : [> ] t -> serial:int32 ->
                                           surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Server]) Proxy.t option ->
                                           hotspot_x:int32 -> hotspot_y:int32 -> unit
    
    method private virtual on_destroy : [> ] t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let serial = Msg.get_int _msg in
        let surface : ([`Wl_surface], _, _) Proxy.t option =
          match Msg.get_int _msg with
          | 0l -> None
          | id ->
            let Proxy.Proxy p = Proxy.lookup_other _proxy id in
            match Proxy.ty p with
            | Imports.Wl_surface.T -> Some p
            | _ -> Proxy.wrong_type ~parent:_proxy ~expected:"wl_surface" p
          in
        let hotspot_x = Msg.get_int _msg in
        let hotspot_y = Msg.get_int _msg in
        _self#on_set_cursor _proxy ~serial ~surface ~hotspot_x ~hotspot_y
      | 1 ->
        Proxy.shutdown_recv _proxy;
        _self#on_destroy _proxy 
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_set_cursor : [> `V1] t -> serial:int32 ->
                                           surface:([`Wl_surface], [> Imports.Wl_surface.versions], [`Server]) Proxy.t option ->
                                           hotspot_x:int32 -> hotspot_y:int32 -> unit
    
    (** Set the tablet tool's surface.
        
        Sets the surface of the cursor used for this tool on the given
        tablet. This request only takes effect if the tool is in proximity
        of one of the requesting client's surfaces or the surface parameter
        is the current pointer surface. If there was a previous surface set
        with this request it is replaced. If surface is NULL, the cursor
        image is hidden.
        
        The parameters hotspot_x and hotspot_y define the position of the
        pointer surface relative to the pointer location. Its top-left corner
        is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the
        coordinates of the pointer location, in surface-local coordinates.
        
        On surface.attach requests to the pointer surface, hotspot_x and
        hotspot_y are decremented by the x and y parameters passed to the
        request. Attach must be confirmed by wl_surface.commit as usual.
        
        The hotspot can also be updated by passing the currently set pointer
        surface to this request with new values for hotspot_x and hotspot_y.
        
        The current and pending input regions of the wl_surface are cleared,
        and wl_surface.set_input_region is ignored until the wl_surface is no
        longer used as the cursor. When the use as a cursor ends, the current
        and pending input regions become undefined, and the wl_surface is
        unmapped.
        
        This request gives the surface the role of a wp_tablet_tool cursor. A
        surface may only ever be used as the cursor surface for one
        wp_tablet_tool. If the surface already has another role or has
        previously been used as cursor surface for a different tool, a
        protocol error is raised. *)
    
    method private virtual on_destroy : [> `V1] t -> unit
    
    (** Destroy the tool object.
        
        This destroys the client's resource for this tool object. *)
    
    method min_version = 1l
  end
end

(** Graphics tablet device.
    
    The wp_tablet interface represents one graphics tablet device. The
    tablet interface itself does not generate events; all events are
    generated by wp_tablet_tool objects when in proximity above a tablet.
    
    A tablet has a number of static characteristics, e.g. device name and
    pid/vid. These capabilities are sent in an event sequence after the
    wp_tablet_seat.tablet_added event. This initial event sequence is
    terminated by a wp_tablet.done event. *)
module Zwp_tablet_v2 = struct
  type 'v t = ([`Zwp_tablet_v2], 'v, [`Server]) Proxy.t
  
  (** {2 Version 1} *)
  
  (** Tablet removed event.
      
      Sent when the tablet has been removed from the system. When a tablet
      is removed, some tools may be removed.
      
      When this event is received, the client must wp_tablet.destroy
      the object. *)
  let removed (_t:([< `V1] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:4 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg
  
  (** Tablet description events sequence complete.
      
      This event is sent immediately to signal the end of the initial
      burst of descriptive events. A client may consider the static
      description of the tablet to be complete and finalize initialization
      of the tablet. *)
  let done_ (_t:([< `V1] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:3 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg
  
  (** Path to the device.
      
      A system-specific device path that indicates which device is behind
      this wp_tablet. This information may be used to gather additional
      information about the device, e.g. through libwacom.
      
      A device may have more than one device path. If so, multiple
      wp_tablet.path events are sent. A device may be emulated and not
      have a device path, and in that case this event will not be sent.
      
      The format of the path is unspecified, it may be a device node, a
      sysfs path, or some other identifier. It is up to the client to
      identify the string provided.
      
      This event is sent in the initial burst of events before the
      wp_tablet.done event. *)
  let path (_t:([< `V1] as 'v) t) ~path =
    let _msg = Proxy.alloc _t ~op:2 ~ints:1 ~strings:[(Some path)] ~arrays:[] in
    Msg.add_string _msg path;
    Proxy.send _t _msg
  
  (** Tablet device USB vendor/product id.
      
      The USB vendor and product IDs for the tablet device.
      
      If the device has no USB vendor/product ID, this event is not sent.
      This can happen for virtual devices or non-USB devices, for instance.
      
      This event is sent in the initial burst of events before the
      wp_tablet.done event. *)
  let id (_t:([< `V1] as 'v) t) ~vid ~pid =
    let _msg = Proxy.alloc _t ~op:1 ~ints:2 ~strings:[] ~arrays:[] in
    Msg.add_int _msg vid;
    Msg.add_int _msg pid;
    Proxy.send _t _msg
  
  (** Tablet device name.
      
      A descriptive name for the tablet device.
      
      If the device has no descriptive name, this event is not sent.
      
      This event is sent in the initial burst of events before the
      wp_tablet.done event. *)
  let name (_t:([< `V1] as 'v) t) ~name =
    let _msg = Proxy.alloc _t ~op:0 ~ints:1 ~strings:[(Some name)] ~arrays:[] in
    Msg.add_string _msg name;
    Proxy.send _t _msg
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_v2)
    method max_version = 1l
    
    method private virtual on_destroy : [> ] t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        Proxy.shutdown_recv _proxy;
        _self#on_destroy _proxy 
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_destroy : [> `V1] t -> unit
    
    (** Destroy the tablet object.
        
        This destroys the client's resource for this tablet object. *)
    
    method min_version = 1l
  end
end

(** Pad ring.
    
    A circular interaction area, such as the touch ring on the Wacom Intuos
    Pro series tablets.
    
    Events on a ring are logically grouped by the wl_tablet_pad_ring.frame
    event. *)
module Zwp_tablet_pad_ring_v2 = struct
  type 'v t = ([`Zwp_tablet_pad_ring_v2], 'v, [`Server]) Proxy.t
  module Source = Tablet_v2_proto.Zwp_tablet_pad_ring_v2.Source
  
  (** {2 Version 1} *)
  
  (** End of a ring event sequence.
      
      Indicates the end of a set of ring events that logically belong
      together. A client is expected to accumulate the data in all events
      within the frame before proceeding.
      
      All wp_tablet_pad_ring events before a wp_tablet_pad_ring.frame event belong
      logically together. For example, on termination of a finger interaction
      on a ring the compositor will send a wp_tablet_pad_ring.source event,
      a wp_tablet_pad_ring.stop event and a wp_tablet_pad_ring.frame event.
      
      A wp_tablet_pad_ring.frame event is sent for every logical event
      group, even if the group only contains a single wp_tablet_pad_ring
      event. Specifically, a client may get a sequence: angle, frame,
      angle, frame, etc. *)
  let frame (_t:([< `V1] as 'v) t) ~time =
    let _msg = Proxy.alloc _t ~op:3 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg time;
    Proxy.send _t _msg
  
  (** Interaction stopped.
      
      Stop notification for ring events.
      
      For some wp_tablet_pad_ring.source types, a wp_tablet_pad_ring.stop
      event is sent to notify a client that the interaction with the ring
      has terminated. This enables the client to implement kinetic scrolling.
      See the wp_tablet_pad_ring.source documentation for information on
      when this event may be generated.
      
      Any wp_tablet_pad_ring.angle events with the same source after this
      event should be considered as the start of a new interaction. *)
  let stop (_t:([< `V1] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:2 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg
  
  (** Angle changed.
      
      Sent whenever the angle on a ring changes.
      
      The angle is provided in degrees clockwise from the logical
      north of the ring in the pad's current rotation. *)
  let angle (_t:([< `V1] as 'v) t) ~degrees =
    let _msg = Proxy.alloc _t ~op:1 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_fixed _msg degrees;
    Proxy.send _t _msg
  
  (** Ring event source.
      
      Source information for ring events.
      
      This event does not occur on its own. It is sent before a
      wp_tablet_pad_ring.frame event and carries the source information
      for all events within that frame.
      
      The source specifies how this event was generated. If the source is
      wp_tablet_pad_ring.source.finger, a wp_tablet_pad_ring.stop event
      will be sent when the user lifts the finger off the device.
      
      This event is optional. If the source is unknown for an interaction,
      no event is sent. *)
  let source (_t:([< `V1] as 'v) t) ~source =
    let _msg = Proxy.alloc _t ~op:0 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Imports.Zwp_tablet_pad_ring_v2.Source.to_int32 source);
    Proxy.send _t _msg
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_pad_ring_v2)
    method max_version = 1l
    
    method private virtual on_set_feedback : [> ] t -> description:string -> serial:int32 -> unit
    
    method private virtual on_destroy : [> ] t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let description = Msg.get_string _msg in
        let serial = Msg.get_int _msg in
        _self#on_set_feedback _proxy ~description ~serial
      | 1 ->
        Proxy.shutdown_recv _proxy;
        _self#on_destroy _proxy 
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_set_feedback : [> `V1] t -> description:string -> serial:int32 -> unit
    
    (** Set compositor feedback.
        
        Request that the compositor use the provided feedback string
        associated with this ring. This request should be issued immediately
        after a wp_tablet_pad_group.mode_switch event from the corresponding
        group is received, or whenever the ring is mapped to a different
        action. See wp_tablet_pad_group.mode_switch for more details.
        
        Clients are encouraged to provide context-aware descriptions for
        the actions associated with the ring; compositors may use this
        information to offer visual feedback about the button layout
        (eg. on-screen displays).
        
        The provided string 'description' is a UTF-8 encoded string to be
        associated with this ring, and is considered user-visible; general
        internationalization rules apply.
        
        The serial argument will be that of the last
        wp_tablet_pad_group.mode_switch event received for the group of this
        ring. Requests providing other serials than the most recent one will be
        ignored. *)
    
    method private virtual on_destroy : [> `V1] t -> unit
    
    (** Destroy the ring object.
        
        This destroys the client's resource for this ring object. *)
    
    method min_version = 1l
  end
end

(** Pad strip.
    
    A linear interaction area, such as the strips found in Wacom Cintiq
    models.
    
    Events on a strip are logically grouped by the wl_tablet_pad_strip.frame
    event. *)
module Zwp_tablet_pad_strip_v2 = struct
  type 'v t = ([`Zwp_tablet_pad_strip_v2], 'v, [`Server]) Proxy.t
  module Source = Tablet_v2_proto.Zwp_tablet_pad_strip_v2.Source
  
  (** {2 Version 1} *)
  
  (** End of a strip event sequence.
      
      Indicates the end of a set of events that represent one logical
      hardware strip event. A client is expected to accumulate the data
      in all events within the frame before proceeding.
      
      All wp_tablet_pad_strip events before a wp_tablet_pad_strip.frame event belong
      logically together. For example, on termination of a finger interaction
      on a strip the compositor will send a wp_tablet_pad_strip.source event,
      a wp_tablet_pad_strip.stop event and a wp_tablet_pad_strip.frame
      event.
      
      A wp_tablet_pad_strip.frame event is sent for every logical event
      group, even if the group only contains a single wp_tablet_pad_strip
      event. Specifically, a client may get a sequence: position, frame,
      position, frame, etc. *)
  let frame (_t:([< `V1] as 'v) t) ~time =
    let _msg = Proxy.alloc _t ~op:3 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg time;
    Proxy.send _t _msg
  
  (** Interaction stopped.
      
      Stop notification for strip events.
      
      For some wp_tablet_pad_strip.source types, a wp_tablet_pad_strip.stop
      event is sent to notify a client that the interaction with the strip
      has terminated. This enables the client to implement kinetic
      scrolling. See the wp_tablet_pad_strip.source documentation for
      information on when this event may be generated.
      
      Any wp_tablet_pad_strip.position events with the same source after this
      event should be considered as the start of a new interaction. *)
  let stop (_t:([< `V1] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:2 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg
  
  (** Position changed.
      
      Sent whenever the position on a strip changes.
      
      The position is normalized to a range of [0, 65535], the 0-value
      represents the top-most and/or left-most position of the strip in
      the pad's current rotation. *)
  let position (_t:([< `V1] as 'v) t) ~position =
    let _msg = Proxy.alloc _t ~op:1 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg position;
    Proxy.send _t _msg
  
  (** Strip event source.
      
      Source information for strip events.
      
      This event does not occur on its own. It is sent before a
      wp_tablet_pad_strip.frame event and carries the source information
      for all events within that frame.
      
      The source specifies how this event was generated. If the source is
      wp_tablet_pad_strip.source.finger, a wp_tablet_pad_strip.stop event
      will be sent when the user lifts their finger off the device.
      
      This event is optional. If the source is unknown for an interaction,
      no event is sent. *)
  let source (_t:([< `V1] as 'v) t) ~source =
    let _msg = Proxy.alloc _t ~op:0 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Imports.Zwp_tablet_pad_strip_v2.Source.to_int32 source);
    Proxy.send _t _msg
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_pad_strip_v2)
    method max_version = 1l
    
    method private virtual on_set_feedback : [> ] t -> description:string -> serial:int32 -> unit
    
    method private virtual on_destroy : [> ] t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let description = Msg.get_string _msg in
        let serial = Msg.get_int _msg in
        _self#on_set_feedback _proxy ~description ~serial
      | 1 ->
        Proxy.shutdown_recv _proxy;
        _self#on_destroy _proxy 
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_set_feedback : [> `V1] t -> description:string -> serial:int32 -> unit
    
    (** Set compositor feedback.
        
        Requests the compositor to use the provided feedback string
        associated with this strip. This request should be issued immediately
        after a wp_tablet_pad_group.mode_switch event from the corresponding
        group is received, or whenever the strip is mapped to a different
        action. See wp_tablet_pad_group.mode_switch for more details.
        
        Clients are encouraged to provide context-aware descriptions for
        the actions associated with the strip, and compositors may use this
        information to offer visual feedback about the button layout
        (eg. on-screen displays).
        
        The provided string 'description' is a UTF-8 encoded string to be
        associated with this ring, and is considered user-visible; general
        internationalization rules apply.
        
        The serial argument will be that of the last
        wp_tablet_pad_group.mode_switch event received for the group of this
        strip. Requests providing other serials than the most recent one will be
        ignored. *)
    
    method private virtual on_destroy : [> `V1] t -> unit
    
    (** Destroy the strip object.
        
        This destroys the client's resource for this strip object. *)
    
    method min_version = 1l
  end
end

(** A set of buttons, rings and strips.
    
    A pad group describes a distinct (sub)set of buttons, rings and strips
    present in the tablet. The criteria of this grouping is usually positional,
    eg. if a tablet has buttons on the left and right side, 2 groups will be
    presented. The physical arrangement of groups is undisclosed and may
    change on the fly.
    
    Pad groups will announce their features during pad initialization. Between
    the corresponding wp_tablet_pad.group event and wp_tablet_pad_group.done, the
    pad group will announce the buttons, rings and strips contained in it,
    plus the number of supported modes.
    
    Modes are a mechanism to allow multiple groups of actions for every element
    in the pad group. The number of groups and available modes in each is
    persistent across device plugs. The current mode is user-switchable, it
    will be announced through the wp_tablet_pad_group.mode_switch event both
    whenever it is switched, and after wp_tablet_pad.enter.
    
    The current mode logically applies to all elements in the pad group,
    although it is at clients' discretion whether to actually perform different
    actions, and/or issue the respective .set_feedback requests to notify the
    compositor. See the wp_tablet_pad_group.mode_switch event for more details. *)
module Zwp_tablet_pad_group_v2 = struct
  type 'v t = ([`Zwp_tablet_pad_group_v2], 'v, [`Server]) Proxy.t
  
  (** {2 Version 1} *)
  
  (** Mode switch event.
      
      Notification that the mode was switched.
      
      A mode applies to all buttons, rings and strips in a group
      simultaneously, but a client is not required to assign different actions
      for each mode. For example, a client may have mode-specific button
      mappings but map the ring to vertical scrolling in all modes. Mode
      indices start at 0.
      
      Switching modes is compositor-dependent. The compositor may provide
      visual cues to the user about the mode, e.g. by toggling LEDs on
      the tablet device. Mode-switching may be software-controlled or
      controlled by one or more physical buttons. For example, on a Wacom
      Intuos Pro, the button inside the ring may be assigned to switch
      between modes.
      
      The compositor will also send this event after wp_tablet_pad.enter on
      each group in order to notify of the current mode. Groups that only
      feature one mode will use mode=0 when emitting this event.
      
      If a button action in the new mode differs from the action in the
      previous mode, the client should immediately issue a
      wp_tablet_pad.set_feedback request for each changed button.
      
      If a ring or strip action in the new mode differs from the action
      in the previous mode, the client should immediately issue a
      wp_tablet_ring.set_feedback or wp_tablet_strip.set_feedback request
      for each changed ring or strip. *)
  let mode_switch (_t:([< `V1] as 'v) t) ~time ~serial ~mode =
    let _msg = Proxy.alloc _t ~op:5 ~ints:3 ~strings:[] ~arrays:[] in
    Msg.add_int _msg time;
    Msg.add_int _msg serial;
    Msg.add_int _msg mode;
    Proxy.send _t _msg
  
  (** Tablet group description events sequence complete.
      
      This event is sent immediately to signal the end of the initial
      burst of descriptive events. A client may consider the static
      description of the tablet to be complete and finalize initialization
      of the tablet group. *)
  let done_ (_t:([< `V1] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:4 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg
  
  (** Mode-switch ability announced.
      
      Sent on wp_tablet_pad_group initialization to announce that the pad
      group may switch between modes. A client may use a mode to store a
      specific configuration for buttons, rings and strips and use the
      wl_tablet_pad_group.mode_switch event to toggle between these
      configurations. Mode indices start at 0.
      
      Switching modes is compositor-dependent. See the
      wp_tablet_pad_group.mode_switch event for more details.
      
      This event is sent in the initial burst of events before the
      wp_tablet_pad_group.done event. This event is only sent when more than
      more than one mode is available. *)
  let modes (_t:([< `V1] as 'v) t) ~modes =
    let _msg = Proxy.alloc _t ~op:3 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg modes;
    Proxy.send _t _msg
  
  (** Strip announced.
      
      Sent on wp_tablet_pad initialization to announce available strips.
      One event is sent for each strip available on this pad group.
      
      This event is sent in the initial burst of events before the
      wp_tablet_pad_group.done event. *)
  let strip (_t:([< `V1] as 'v) t) (strip:([`Zwp_tablet_pad_strip_v2], 'v, [`Server]) #Proxy.Handler.t) =
    let __strip = Proxy.spawn _t strip in
    let _msg = Proxy.alloc _t ~op:2 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Proxy.id __strip);
    Proxy.send _t _msg;
    __strip
  
  (** Ring announced.
      
      Sent on wp_tablet_pad_group initialization to announce available rings.
      One event is sent for each ring available on this pad group.
      
      This event is sent in the initial burst of events before the
      wp_tablet_pad_group.done event. *)
  let ring (_t:([< `V1] as 'v) t) (ring:([`Zwp_tablet_pad_ring_v2], 'v, [`Server]) #Proxy.Handler.t) =
    let __ring = Proxy.spawn _t ring in
    let _msg = Proxy.alloc _t ~op:1 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Proxy.id __ring);
    Proxy.send _t _msg;
    __ring
  
  (** Buttons announced.
      
      Sent on wp_tablet_pad_group initialization to announce the available
      buttons in the group. Button indices start at 0, a button may only be
      in one group at a time.
      
      This event is first sent in the initial burst of events before the
      wp_tablet_pad_group.done event.
      
      Some buttons are reserved by the compositor. These buttons may not be
      assigned to any wp_tablet_pad_group. Compositors may broadcast this
      event in the case of changes to the mapping of these reserved buttons.
      If the compositor happens to reserve all buttons in a group, this event
      will be sent with an empty array. *)
  let buttons (_t:([< `V1] as 'v) t) ~buttons =
    let _msg = Proxy.alloc _t ~op:0 ~ints:1 ~strings:[] ~arrays:[buttons] in
    Msg.add_array _msg buttons;
    Proxy.send _t _msg
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_pad_group_v2)
    method max_version = 1l
    
    method private virtual on_destroy : [> ] t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        Proxy.shutdown_recv _proxy;
        _self#on_destroy _proxy 
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_destroy : [> `V1] t -> unit
    
    (** Destroy the pad object.
        
        Destroy the wp_tablet_pad_group object. Objects created from this object
        are unaffected and should be destroyed separately. *)
    
    method min_version = 1l
  end
end

(** A set of buttons, rings and strips.
    
    A pad device is a set of buttons, rings and strips
    usually physically present on the tablet device itself. Some
    exceptions exist where the pad device is physically detached, e.g. the
    Wacom ExpressKey Remote.
    
    Pad devices have no axes that control the cursor and are generally
    auxiliary devices to the tool devices used on the tablet surface.
    
    A pad device has a number of static characteristics, e.g. the number
    of rings. These capabilities are sent in an event sequence after the
    wp_tablet_seat.pad_added event before any actual events from this pad.
    This initial event sequence is terminated by a wp_tablet_pad.done
    event.
    
    All pad features (buttons, rings and strips) are logically divided into
    groups and all pads have at least one group. The available groups are
    notified through the wp_tablet_pad.group event; the compositor will
    emit one event per group before emitting wp_tablet_pad.done.
    
    Groups may have multiple modes. Modes allow clients to map multiple
    actions to a single pad feature. Only one mode can be active per group,
    although different groups may have different active modes. *)
module Zwp_tablet_pad_v2 = struct
  type 'v t = ([`Zwp_tablet_pad_v2], 'v, [`Server]) Proxy.t
  module Button_state = Tablet_v2_proto.Zwp_tablet_pad_v2.Button_state
  
  (** {2 Version 1} *)
  
  (** Pad removed event.
      
      Sent when the pad has been removed from the system. When a tablet
      is removed its pad(s) will be removed too.
      
      When this event is received, the client must destroy all rings, strips
      and groups that were offered by this pad, and issue wp_tablet_pad.destroy
      the pad itself. *)
  let removed (_t:([< `V1] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:7 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg
  
  (** Leave event.
      
      Notification that this pad is no longer focused on the specified
      surface. *)
  let leave (_t:([< `V1] as 'v) t) ~serial ~(surface:([`Wl_surface], _, [`Server]) Proxy.t) =
    let _msg = Proxy.alloc _t ~op:6 ~ints:2 ~strings:[] ~arrays:[] in
    Msg.add_int _msg serial;
    Msg.add_int _msg (Proxy.id surface);
    Proxy.send _t _msg
  
  (** Enter event.
      
      Notification that this pad is focused on the specified surface. *)
  let enter (_t:([< `V1] as 'v) t) ~serial ~(tablet:([`Zwp_tablet_v2], _, [`Server]) Proxy.t) ~(surface:([`Wl_surface], _, [`Server]) Proxy.t) =
    let _msg = Proxy.alloc _t ~op:5 ~ints:3 ~strings:[] ~arrays:[] in
    Msg.add_int _msg serial;
    Msg.add_int _msg (Proxy.id tablet);
    Msg.add_int _msg (Proxy.id surface);
    Proxy.send _t _msg
  
  (** Physical button state.
      
      Sent whenever the physical state of a button changes. *)
  let button (_t:([< `V1] as 'v) t) ~time ~button ~state =
    let _msg = Proxy.alloc _t ~op:4 ~ints:3 ~strings:[] ~arrays:[] in
    Msg.add_int _msg time;
    Msg.add_int _msg button;
    Msg.add_int _msg (Imports.Zwp_tablet_pad_v2.Button_state.to_int32 state);
    Proxy.send _t _msg
  
  (** Pad description event sequence complete.
      
      This event signals the end of the initial burst of descriptive
      events. A client may consider the static description of the pad to
      be complete and finalize initialization of the pad. *)
  let done_ (_t:([< `V1] as 'v) t)  =
    let _msg = Proxy.alloc _t ~op:3 ~ints:0 ~strings:[] ~arrays:[] in
    Proxy.send _t _msg
  
  (** Buttons announced.
      
      Sent on wp_tablet_pad initialization to announce the available
      buttons.
      
      This event is sent in the initial burst of events before the
      wp_tablet_pad.done event. This event is only sent when at least one
      button is available. *)
  let buttons (_t:([< `V1] as 'v) t) ~buttons =
    let _msg = Proxy.alloc _t ~op:2 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg buttons;
    Proxy.send _t _msg
  
  (** Path to the device.
      
      A system-specific device path that indicates which device is behind
      this wp_tablet_pad. This information may be used to gather additional
      information about the device, e.g. through libwacom.
      
      The format of the path is unspecified, it may be a device node, a
      sysfs path, or some other identifier. It is up to the client to
      identify the string provided.
      
      This event is sent in the initial burst of events before the
      wp_tablet_pad.done event. *)
  let path (_t:([< `V1] as 'v) t) ~path =
    let _msg = Proxy.alloc _t ~op:1 ~ints:1 ~strings:[(Some path)] ~arrays:[] in
    Msg.add_string _msg path;
    Proxy.send _t _msg
  
  (** Group announced.
      
      Sent on wp_tablet_pad initialization to announce available groups.
      One event is sent for each pad group available.
      
      This event is sent in the initial burst of events before the
      wp_tablet_pad.done event. At least one group will be announced. *)
  let group (_t:([< `V1] as 'v) t) (pad_group:([`Zwp_tablet_pad_group_v2], 'v, [`Server]) #Proxy.Handler.t) =
    let __pad_group = Proxy.spawn _t pad_group in
    let _msg = Proxy.alloc _t ~op:0 ~ints:1 ~strings:[] ~arrays:[] in
    Msg.add_int _msg (Proxy.id __pad_group);
    Proxy.send _t _msg;
    __pad_group
  
  (**/**)
  class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
    method user_data = S.No_data
    method metadata = (module Tablet_v2_proto.Zwp_tablet_pad_v2)
    method max_version = 1l
    
    method private virtual on_set_feedback : [> ] t -> button:int32 -> description:string -> serial:int32 -> unit
    
    method private virtual on_destroy : [> ] t -> unit
    
    
    method dispatch (_proxy : 'v t) _msg =
      let _proxy = Proxy.cast_version _proxy in
      match Msg.op _msg with
      | 0 ->
        let button = Msg.get_int _msg in
        let description = Msg.get_string _msg in
        let serial = Msg.get_int _msg in
        _self#on_set_feedback _proxy ~button ~description ~serial
      | 1 ->
        Proxy.shutdown_recv _proxy;
        _self#on_destroy _proxy 
      | _ -> assert false
  end
  (**/**)
  
  (** {2 Handlers}
      Note: Servers will always want to use [v1].
   *)
  
  
  (** Handler for a proxy with version >= 1. *)
  class virtual ['v] v1 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
    (**/**)
    inherit [[< `V1] as 'v] _handlers_unsafe
    (**/**)
    method private virtual on_set_feedback : [> `V1] t -> button:int32 -> description:string -> serial:int32 -> unit
    
    (** Set compositor feedback.
        
        Requests the compositor to use the provided feedback string
        associated with this button. This request should be issued immediately
        after a wp_tablet_pad_group.mode_switch event from the corresponding
        group is received, or whenever a button is mapped to a different
        action. See wp_tablet_pad_group.mode_switch for more details.
        
        Clients are encouraged to provide context-aware descriptions for
        the actions associated with each button, and compositors may use
        this information to offer visual feedback on the button layout
        (e.g. on-screen displays).
        
        Button indices start at 0. Setting the feedback string on a button
        that is reserved by the compositor (i.e. not belonging to any
        wp_tablet_pad_group) does not generate an error but the compositor
        is free to ignore the request.
        
        The provided string 'description' is a UTF-8 encoded string to be
        associated with this ring, and is considered user-visible; general
        internationalization rules apply.
        
        The serial argument will be that of the last
        wp_tablet_pad_group.mode_switch event received for the group of this
        button. Requests providing other serials than the most recent one will
        be ignored. *)
    
    method private virtual on_destroy : [> `V1] t -> unit
    
    (** Destroy the pad object.
        
        Destroy the wp_tablet_pad object. Objects created from this object
        are unaffected and should be destroyed separately. *)
    
    method min_version = 1l
  end
end
OCaml

Innovation. Community. Security.