Source file river_xkb_config_v1_client.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
[@@@ocaml.warning "-27-34"]
open struct
module Imports = struct
include River_xkb_config_v1_proto
include River_input_management_v1_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
(** Xkb config global interface.
Global interface for configuring xkb devices.
This global should only be advertised if river_input_manager_v1 is
advertised as well. *)
module River_xkb_config_v1 = struct
type 'v t = ([`River_xkb_config_v1], 'v, [`Client]) Proxy.t
module Error = River_xkb_config_v1_proto.River_xkb_config_v1.Error
module Keymap_format = River_xkb_config_v1_proto.River_xkb_config_v1.Keymap_format
(** {2 Version 1, 2} *)
(** Create a keymap object.
The server must be able to mmap the fd with MAP_PRIVATE.
The server will fstat the fd to obtain the size of the keymap.
The client must not modify the contents of the fd after making this request.
The client should seal the fd with fcntl. *)
let create_keymap (_t:([< `V1 | `V2] as 'v) t) (id:([`River_xkb_keymap_v1], 'v, [`Client]) #Proxy.Handler.t) ~fd ~format =
let __id = Proxy.spawn _t id in
let _msg = Proxy.alloc _t ~op:2 ~ints:3 ~strings:[] ~arrays:[] in
Msg.add_int _msg (Proxy.id __id);
Msg.add_fd _msg fd;
Msg.add_int _msg (Imports.River_xkb_config_v1.Keymap_format.to_int32 format);
Proxy.send _t _msg;
__id
(** Destroy the river_xkb_config_v1 object.
This request should be called after the finished event has been received
to complete destruction of the object.
It is a protocol error to make this request before the finished event
has been received.
If a client wishes to destroy this object it should send a
river_xkb_config_v1.stop request and wait for a
river_xkb_config_v1.finished event. Once the finished event is received
it is safe to destroy this object and any other objects created through
this interface. *)
let destroy (_t:([< `V1 | `V2] as 'v) t) =
let _msg = Proxy.alloc _t ~op:1 ~ints:0 ~strings:[] ~arrays:[] in
Proxy.send _t _msg;
Proxy.shutdown_send _t
(** Stop sending events.
This request indicates that the client no longer wishes to receive
events on this object.
The Wayland protocol is asynchronous, which means the server may send
further events until the stop request is processed. The client must wait
for a river_xkb_config_v1.finished event before destroying this object. *)
let stop (_t:([< `V1 | `V2] as 'v) t) =
let _msg = Proxy.alloc _t ~op:0 ~ints:0 ~strings:[] ~arrays:[] in
Proxy.send _t _msg
(**/**)
class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
method user_data = S.No_data
method metadata = (module River_xkb_config_v1_proto.River_xkb_config_v1)
method max_version = 2l
method private virtual on_finished : [> ] t -> unit
method private virtual on_xkb_keyboard : [> ] t -> ([`River_xkb_keyboard_v1], 'v, [`Client]) Proxy.t -> unit
method dispatch (_proxy : 'v t) _msg =
let _proxy = Proxy.cast_version _proxy in
match Msg.op _msg with
| 0 ->
_self#on_finished _proxy
| 1 ->
let id : ([`River_xkb_keyboard_v1], _, _) Proxy.t =
Msg.get_int _msg |> Proxy.Handler.accept_new _proxy (module Imports.River_xkb_keyboard_v1) in
_self#on_xkb_keyboard _proxy id
| _ -> 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 | `V2] as 'v] _handlers_unsafe
(**/**)
method private virtual on_finished : [> `V1 | `V2] t -> unit
(** The server has finished with the object.
This event indicates that the server will send no further events on this
object. The client should destroy the object. See
river_xkb_config_v1.destroy for more information. *)
method private virtual on_xkb_keyboard : [> `V1 | `V2] t -> ([`River_xkb_keyboard_v1], 'v, [`Client]) Proxy.t ->
unit
(** New xkb keyboard.
A new xkbcommon keyboard has been created. Not every
river_input_device_v1 is necessarily an xkbcommon keyboard as well. *)
method min_version = 1l
method bind_version : [`V1] = `V1
end
(** Handler for a proxy with version >= 2. *)
class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
(**/**)
inherit [[< `V2] as 'v] _handlers_unsafe
(**/**)
method private virtual on_finished : [> `V2] t -> unit
(** The server has finished with the object.
This event indicates that the server will send no further events on this
object. The client should destroy the object. See
river_xkb_config_v1.destroy for more information. *)
method private virtual on_xkb_keyboard : [> `V2] t -> ([`River_xkb_keyboard_v1], 'v, [`Client]) Proxy.t -> unit
(** New xkb keyboard.
A new xkbcommon keyboard has been created. Not every
river_input_device_v1 is necessarily an xkbcommon keyboard as well. *)
method min_version = 2l
method bind_version : [`V2] = `V2
end
end
(** Xkbcommon keymap.
This object is the result of attempting to create an xkbcommon keymap. *)
module River_xkb_keymap_v1 = struct
type 'v t = ([`River_xkb_keymap_v1], 'v, [`Client]) Proxy.t
(** {2 Version 1, 2} *)
(** Destroy the keymap object.
This request indicates that the client will no longer use the keymap
object and that it may be safely destroyed. *)
let destroy (_t:([< `V1 | `V2] as 'v) t) =
let _msg = Proxy.alloc _t ~op:0 ~ints:0 ~strings:[] ~arrays:[] in
Proxy.send _t _msg;
Proxy.shutdown_send _t
(**/**)
class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
method user_data = S.No_data
method metadata = (module River_xkb_config_v1_proto.River_xkb_keymap_v1)
method max_version = 2l
method private virtual on_success : [> ] t -> unit
method private virtual on_failure : [> ] t -> error_msg:string -> unit
method dispatch (_proxy : 'v t) _msg =
let _proxy = Proxy.cast_version _proxy in
match Msg.op _msg with
| 0 ->
_self#on_success _proxy
| 1 ->
let error_msg = Msg.get_string _msg in
_self#on_failure _proxy ~error_msg
| _ -> 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 | `V2] as 'v] _handlers_unsafe
(**/**)
method private virtual on_success : [> `V1 | `V2] t -> unit
(** Keymap creation succeeded.
The keymap object was successfully created and may be used with the
river_xkb_keyboard_v1.set_keymap request. *)
method private virtual on_failure : [> `V1 | `V2] t -> error_msg:string -> unit
(** Keymap creation failed.
The compositor failed to create a keymap from the given parameters.
It is a protocol error to use this keymap object with
river_xkb_keyboard_v1.set_keymap. *)
method min_version = 1l
end
(** Handler for a proxy with version >= 2. *)
class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
(**/**)
inherit [[< `V2] as 'v] _handlers_unsafe
(**/**)
method private virtual on_success : [> `V2] t -> unit
(** Keymap creation succeeded.
The keymap object was successfully created and may be used with the
river_xkb_keyboard_v1.set_keymap request. *)
method private virtual on_failure : [> `V2] t -> error_msg:string -> unit
(** Keymap creation failed.
The compositor failed to create a keymap from the given parameters.
It is a protocol error to use this keymap object with
river_xkb_keyboard_v1.set_keymap. *)
method min_version = 2l
end
end
(** Xkbcommon keyboard device.
This object represent a physical keyboard which has its configuration and
state managed by xkbcommon. *)
module River_xkb_keyboard_v1 = struct
type 'v t = ([`River_xkb_keyboard_v1], 'v, [`Client]) Proxy.t
module Error = River_xkb_config_v1_proto.River_xkb_keyboard_v1.Error
(** {2 Version 1} *)
(** Disable numlock.
Disable numlock for the keyboard. *)
let numlock_disable (_t:([< `V1 | `V2] as 'v) t) =
let _msg = Proxy.alloc _t ~op:7 ~ints:0 ~strings:[] ~arrays:[] in
Proxy.send _t _msg
(** Enable numlock.
Enable numlock for the keyboard. *)
let numlock_enable (_t:([< `V1 | `V2] as 'v) t) =
let _msg = Proxy.alloc _t ~op:6 ~ints:0 ~strings:[] ~arrays:[] in
Proxy.send _t _msg
(** Disable capslock.
Disable capslock for the keyboard. *)
let capslock_disable (_t:([< `V1 | `V2] as 'v) t) =
let _msg = Proxy.alloc _t ~op:5 ~ints:0 ~strings:[] ~arrays:[] in
Proxy.send _t _msg
(** Enable capslock.
Enable capslock for the keyboard. *)
let capslock_enable (_t:([< `V1 | `V2] as 'v) t) =
let _msg = Proxy.alloc _t ~op:4 ~ints:0 ~strings:[] ~arrays:[] in
Proxy.send _t _msg
(** Set the active layout by name.
Set the active layout for the keyboard's keymap. Has no effect if there
is no layout with the give name for the keyboard's keymap. *)
let set_layout_by_name (_t:([< `V1 | `V2] as 'v) t) ~name =
let _msg = Proxy.alloc _t ~op:3 ~ints:1 ~strings:[(Some name)] ~arrays:[] in
Msg.add_string _msg name;
Proxy.send _t _msg
(** Set the active layout by index.
Set the active layout for the keyboard's keymap. Has no effect if the
layout index is out of bounds for the current keymap. *)
let set_layout_by_index (_t:([< `V1 | `V2] as 'v) t) ~index =
let _msg = Proxy.alloc _t ~op:2 ~ints:1 ~strings:[] ~arrays:[] in
Msg.add_int _msg index;
Proxy.send _t _msg
(** Set the keymap.
Set the keymap for the keyboard.
Setting a keymap will reset all layout/modifier state.
It is a protocol error to pass a keymap object for which the
river_xkb_keymap_v1.success event was not received. *)
let set_keymap (_t:([< `V1 | `V2] as 'v) t) ~(keymap:([`River_xkb_keymap_v1], _, [`Client]) Proxy.t) =
let _msg = Proxy.alloc _t ~op:1 ~ints:1 ~strings:[] ~arrays:[] in
Msg.add_int _msg (Proxy.id keymap);
Proxy.send _t _msg
(** Destroy the xkb keyboard object.
This request indicates that the client will no longer use the keyboard
object and that it may be safely destroyed. *)
let destroy (_t:([< `V1 | `V2] as 'v) t) =
let _msg = Proxy.alloc _t ~op:0 ~ints:0 ~strings:[] ~arrays:[] in
Proxy.send _t _msg;
Proxy.shutdown_send _t
(** {2 Version 2} *)
(**/**)
class virtual ['v] _handlers_unsafe = object (_self : (_, 'v, _) #Proxy.Handler.t)
method user_data = S.No_data
method metadata = (module River_xkb_config_v1_proto.River_xkb_keyboard_v1)
method max_version = 2l
method private virtual on_removed : [> ] t -> unit
method private virtual on_input_device : [> ] t -> device:([`River_input_device_v1], [> Imports.River_input_device_v1.versions], [`Client]) Proxy.t ->
unit
method private virtual on_layout : [> ] t -> index:int32 -> name:string option -> unit
method private virtual on_capslock_enabled : [> ] t -> unit
method private virtual on_capslock_disabled : [> ] t -> unit
method private virtual on_numlock_enabled : [> ] t -> unit
method private virtual on_numlock_disabled : [> ] t -> unit
method private virtual on_done : [> ] t -> unit
method dispatch (_proxy : 'v t) _msg =
let _proxy = Proxy.cast_version _proxy in
match Msg.op _msg with
| 0 ->
_self#on_removed _proxy
| 1 ->
let device : ([`River_input_device_v1], _, _) Proxy.t =
let Proxy.Proxy p = Msg.get_int _msg |> Proxy.lookup_other _proxy in
match Proxy.ty p with
| Imports.River_input_device_v1.T -> p
| _ -> Proxy.wrong_type ~parent:_proxy ~expected:"river_input_device_v1" p
in
_self#on_input_device _proxy ~device
| 2 ->
let index = Msg.get_int _msg in
let name = Msg.get_string_opt _msg in
_self#on_layout _proxy ~index ~name
| 3 ->
_self#on_capslock_enabled _proxy
| 4 ->
_self#on_capslock_disabled _proxy
| 5 ->
_self#on_numlock_enabled _proxy
| 6 ->
_self#on_numlock_disabled _proxy
| 7 ->
_self#on_done _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 | `V2] as 'v] _handlers_unsafe
(**/**)
method private virtual on_removed : [> `V1 | `V2] t -> unit
(** The xkb keyboard is removed.
This event indicates that the xkb keyboard has been removed.
The server will send no further events on this object and ignore any
request (other than river_xkb_keyboard_v1.destroy) made after this event
is sent. The client should destroy this object with the
river_xkb_keyboard_v1.destroy request to free up resources. *)
method private virtual on_input_device : [> `V1 | `V2] t -> device:([`River_input_device_v1], [> Imports.River_input_device_v1.versions], [`Client]) Proxy.t ->
unit
(** Corresponding river input device.
The river_input_device_v1 corresponding to this xkb keyboard. This event
will always be the first event sent on the river_xkb_keyboard_v1 object,
and it will be sent exactly once. *)
method private virtual on_layout : [> `V1 | `V2] t -> index:int32 -> name:string option -> unit
(** Currently active layout.
The currently active layout index and name. The name arg may be null if
the active layout does not have a name.
This event is sent once when the river_xkb_keyboard_v1 is created and
again whenever the layout changes. *)
method private virtual on_capslock_enabled : [> `V1 | `V2] t -> unit
(** Capslock is currently enabled.
Capslock is currently enabled for the keyboard.
This event is sent once when the river_xkb_keyboard_v1 is created and
again whenever the capslock state changes. *)
method private virtual on_capslock_disabled : [> `V1 | `V2] t -> unit
(** Capslock is currently disabled.
Capslock is currently disabled for the keyboard.
This event is sent once when the river_xkb_keyboard_v1 is created and
again whenever the capslock state changes. *)
method private virtual on_numlock_enabled : [> `V1 | `V2] t -> unit
(** Numlock is currently enabled.
Numlock is currently enabled for the keyboard.
This event is sent once when the river_xkb_keyboard_v1 is created and
again whenever the numlock state changes. *)
method private virtual on_numlock_disabled : [> `V1 | `V2] t -> unit
(** Numlock is currently disabled.
Numlock is currently disabled for the keyboard.
This event is sent once when the river_xkb_keyboard_v1 is created and
again whenever the numlock state changes. *)
method private virtual on_done : [> `V2] t -> unit
(** All information has been sent.
This event is sent after all information about the keyboard has been
sent.
This allows changes to one or more river_xkb_keyboard_v1 properties to
be seen as atomic, even if they happen via multiple events. *)
method min_version = 1l
end
(** Handler for a proxy with version >= 2. *)
class virtual ['v] v2 = object (_ : (_, 'v, _) #Proxy.Service_handler.t)
(**/**)
inherit [[< `V2] as 'v] _handlers_unsafe
(**/**)
method private virtual on_removed : [> `V2] t -> unit
(** The xkb keyboard is removed.
This event indicates that the xkb keyboard has been removed.
The server will send no further events on this object and ignore any
request (other than river_xkb_keyboard_v1.destroy) made after this event
is sent. The client should destroy this object with the
river_xkb_keyboard_v1.destroy request to free up resources. *)
method private virtual on_input_device : [> `V2] t -> device:([`River_input_device_v1], [> Imports.River_input_device_v1.versions], [`Client]) Proxy.t ->
unit
(** Corresponding river input device.
The river_input_device_v1 corresponding to this xkb keyboard. This event
will always be the first event sent on the river_xkb_keyboard_v1 object,
and it will be sent exactly once. *)
method private virtual on_layout : [> `V2] t -> index:int32 -> name:string option -> unit
(** Currently active layout.
The currently active layout index and name. The name arg may be null if
the active layout does not have a name.
This event is sent once when the river_xkb_keyboard_v1 is created and
again whenever the layout changes. *)
method private virtual on_capslock_enabled : [> `V2] t -> unit
(** Capslock is currently enabled.
Capslock is currently enabled for the keyboard.
This event is sent once when the river_xkb_keyboard_v1 is created and
again whenever the capslock state changes. *)
method private virtual on_capslock_disabled : [> `V2] t -> unit
(** Capslock is currently disabled.
Capslock is currently disabled for the keyboard.
This event is sent once when the river_xkb_keyboard_v1 is created and
again whenever the capslock state changes. *)
method private virtual on_numlock_enabled : [> `V2] t -> unit
(** Numlock is currently enabled.
Numlock is currently enabled for the keyboard.
This event is sent once when the river_xkb_keyboard_v1 is created and
again whenever the numlock state changes. *)
method private virtual on_numlock_disabled : [> `V2] t -> unit
(** Numlock is currently disabled.
Numlock is currently disabled for the keyboard.
This event is sent once when the river_xkb_keyboard_v1 is created and
again whenever the numlock state changes. *)
method private virtual on_done : [> `V2] t -> unit
(** All information has been sent.
This event is sent after all information about the keyboard has been
sent.
This allows changes to one or more river_xkb_keyboard_v1 properties to
be seen as atomic, even if they happen via multiple events. *)
method min_version = 2l
end
end