Source file river_input_management_v1_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
[@@@ocaml.warning "-27-34"]
open struct
module Imports = struct
include River_input_management_v1_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
(** Input manager global interface.
Input manager global interface. *)
module River_input_manager_v1 = struct
type 'v t = ([`River_input_manager_v1], 'v, [`Server]) Proxy.t
module Error = River_input_management_v1_proto.River_input_manager_v1.Error
(** {2 Version 1, 2} *)
(** New input device.
A new input device has been created. *)
let input_device (_t:([< `V1 | `V2] as 'v) t) (id:([`River_input_device_v1], '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
(** The server has finished with the input manager.
This event indicates that the server will send no further events on this
object. The client should destroy the object. See
river_input_manager_v1.destroy for more information. *)
let finished (_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_input_management_v1_proto.River_input_manager_v1)
method max_version = 2l
method private virtual on_stop : [> ] t -> unit
method private virtual on_destroy : [> ] t -> unit
method private virtual on_create_seat : [> ] t -> name:string -> unit
method private virtual on_destroy_seat : [> ] t -> name:string -> unit
method dispatch (_proxy : 'v t) _msg =
let _proxy = Proxy.cast_version _proxy in
match Msg.op _msg with
| 0 ->
_self#on_stop _proxy
| 1 ->
Proxy.shutdown_recv _proxy;
_self#on_destroy _proxy
| 2 ->
let name = Msg.get_string _msg in
_self#on_create_seat _proxy ~name
| 3 ->
let name = Msg.get_string _msg in
_self#on_destroy_seat _proxy ~name
| _ -> 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_stop : [> `V1 | `V2] t -> unit
(** 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_input_manager_v1.finished event before destroying this
object. *)
method private virtual on_destroy : [> `V1 | `V2] t -> unit
(** Destroy the river_input_manager_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_input_manager_v1.stop request and wait for a
river_input_manager_v1.finished event. Once the finished event is
received it is safe to destroy this object and any other objects created
through this interface. *)
method private virtual on_create_seat : [> `V1 | `V2] t -> name:string -> unit
(** Create a new seat.
Create a new seat with the given name. Has no effect if a seat with the
given name already exists.
The default seat with name "default" always exists and does not need to
be explicitly created. *)
method private virtual on_destroy_seat : [> `V1 | `V2] t -> name:string -> unit
(** Destroy a seat.
Destroy the seat with the given name. Has no effect if a seat with the
given name does not exist.
The default seat with name "default" cannot be destroyed and attempting
to destroy it will have no effect.
Any input devices assigned to the destroyed seat at the time of
destruction are assigned to the default seat. *)
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_stop : [> `V2] t -> unit
(** 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_input_manager_v1.finished event before destroying this
object. *)
method private virtual on_destroy : [> `V2] t -> unit
(** Destroy the river_input_manager_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_input_manager_v1.stop request and wait for a
river_input_manager_v1.finished event. Once the finished event is
received it is safe to destroy this object and any other objects created
through this interface. *)
method private virtual on_create_seat : [> `V2] t -> name:string -> unit
(** Create a new seat.
Create a new seat with the given name. Has no effect if a seat with the
given name already exists.
The default seat with name "default" always exists and does not need to
be explicitly created. *)
method private virtual on_destroy_seat : [> `V2] t -> name:string -> unit
(** Destroy a seat.
Destroy the seat with the given name. Has no effect if a seat with the
given name does not exist.
The default seat with name "default" cannot be destroyed and attempting
to destroy it will have no effect.
Any input devices assigned to the destroyed seat at the time of
destruction are assigned to the default seat. *)
method min_version = 2l
method bind_version : [`V2] = `V2
end
end
(** An input device.
An input device represents a physical keyboard, mouse, touchscreen, or
drawing tablet tool. It is assigned to exactly one seat at a time.
By default, all input devices are assigned to the default seat. *)
module River_input_device_v1 = struct
type 'v t = ([`River_input_device_v1], 'v, [`Server]) Proxy.t
module Error = River_input_management_v1_proto.River_input_device_v1.Error
module Type = River_input_management_v1_proto.River_input_device_v1.Type
(** {2 Version 1} *)
(** The name of the input device.
The name of the input device. This event is sent once when the
river_input_device_v1 object is created. The device name cannot
change during the lifetime of the object. *)
let name (_t:([< `V1 | `V2] as 'v) t) ~name =
let _msg = Proxy.alloc _t ~op:2 ~ints:1 ~strings:[(Some name)] ~arrays:[] in
Msg.add_string _msg name;
Proxy.send _t _msg
(** The type of the input device.
The type of the input device. This event is sent once when the
river_input_device_v1 object is created. The device type cannot
change during the lifetime of the object. *)
let type_ (_t:([< `V1 | `V2] as 'v) t) ~type_ =
let _msg = Proxy.alloc _t ~op:1 ~ints:1 ~strings:[] ~arrays:[] in
Msg.add_int _msg (Imports.River_input_device_v1.Type.to_int32 type_);
Proxy.send _t _msg
(** The input device is removed.
This event indicates that the input device has been removed.
The server will send no further events on this object and ignore any
request (other than river_input_device_v1.destroy) made after this event is
sent. The client should destroy this object with the
river_input_device_v1.destroy request to free up resources. *)
let removed (_t:([< `V1 | `V2] as 'v) t) =
let _msg = Proxy.alloc _t ~op:0 ~ints:0 ~strings:[] ~arrays:[] in
Proxy.send _t _msg
(** {2 Version 2} *)
(** All information has been sent.
This event is sent after all information about the input device has
been sent.
This allows changes to one or more river_input_device_v1 properties to
be seen as atomic, even if they happen via multiple events. *)
let done_ (_t:([< `V2] as 'v) t) =
let _msg = Proxy.alloc _t ~op:3 ~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_input_management_v1_proto.River_input_device_v1)
method max_version = 2l
method private virtual on_destroy : [> ] t -> unit
method private virtual on_assign_to_seat : [> ] t -> name:string -> unit
method private virtual on_set_repeat_info : [> ] t -> rate:int32 -> delay:int32 -> unit
method private virtual on_set_scroll_factor : [> ] t -> factor:Fixed.t -> unit
method private virtual on_map_to_output : [> ] t -> output:([`Wl_output], [> Imports.Wl_output.versions], [`Server]) Proxy.t option ->
unit
method private virtual on_map_to_rectangle : [> ] t -> x:int32 -> y:int32 -> width:int32 -> height:int32 -> 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
| 1 ->
let name = Msg.get_string _msg in
_self#on_assign_to_seat _proxy ~name
| 2 ->
let rate = Msg.get_int _msg in
let delay = Msg.get_int _msg in
_self#on_set_repeat_info _proxy ~rate ~delay
| 3 ->
let factor = Msg.get_fixed _msg in
_self#on_set_scroll_factor _proxy ~factor
| 4 ->
let output : ([`Wl_output], _, _) 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_output.T -> Some p
| _ -> Proxy.wrong_type ~parent:_proxy ~expected:"wl_output" p
in
_self#on_map_to_output _proxy ~output
| 5 ->
let x = Msg.get_int _msg in
let y = Msg.get_int _msg in
let width = Msg.get_int _msg in
let height = Msg.get_int _msg in
_self#on_map_to_rectangle _proxy ~x ~y ~width ~height
| _ -> 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_destroy : [> `V1 | `V2] t -> unit
(** Destroy the input device object.
This request indicates that the client will no longer use the input
device object and that it may be safely destroyed. *)
method private virtual on_assign_to_seat : [> `V1 | `V2] t -> name:string -> unit
(** Assign the input device to a seat.
Assign the input device to a seat. All input devices not explicitly
assigned to a seat are considered assigned to the default seat.
Has no effect if a seat with the given name does not exist. *)
method private virtual on_set_repeat_info : [> `V1 | `V2] t -> rate:int32 -> delay:int32 -> unit
(** Set keyboard repeat rate and delay.
Set repeat rate and delay for a keyboard input device. Has no effect if
the device is not a keyboard.
Negative values for either rate or delay are illegal. A rate of zero
will disable any repeating (regardless of the value of delay). *)
method private virtual on_set_scroll_factor : [> `V1 | `V2] t -> factor:Fixed.t -> unit
(** Set scroll factor.
Set the scroll factor for a pointer input device. Has no effect if the
device is not a pointer.
For example, a factor of 0.5 will make scrolling twice as slow while a
factor of 3.0 will make scrolling 3 times as fast.
Setting a scroll factor less than 0 is a protocol error. *)
method private virtual on_map_to_output : [> `V1 | `V2] t -> output:([`Wl_output], [> Imports.Wl_output.versions], [`Server]) Proxy.t option ->
unit
(** Map input device to the given output.
Map the input device to the given output. Has no effect if the device is
not a pointer, touch, or tablet device.
If mapped to both an output and a rectangle, the rectangle has priority.
Passing null clears an existing mapping. *)
method private virtual on_map_to_rectangle : [> `V1 | `V2] t -> x:int32 -> y:int32 -> width:int32 ->
height:int32 -> unit
(** Map input device to the given rectangle.
Map the input device to the given rectangle in the global compositor
coordinate space. Has no effect if the device is not a pointer, touch,
or tablet device.
If mapped to both an output and a rectangle, the rectangle has priority.
Width and height must be greater than or equal to 0.
Passing 0 for width or height clears an existing mapping. *)
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_destroy : [> `V2] t -> unit
(** Destroy the input device object.
This request indicates that the client will no longer use the input
device object and that it may be safely destroyed. *)
method private virtual on_assign_to_seat : [> `V2] t -> name:string -> unit
(** Assign the input device to a seat.
Assign the input device to a seat. All input devices not explicitly
assigned to a seat are considered assigned to the default seat.
Has no effect if a seat with the given name does not exist. *)
method private virtual on_set_repeat_info : [> `V2] t -> rate:int32 -> delay:int32 -> unit
(** Set keyboard repeat rate and delay.
Set repeat rate and delay for a keyboard input device. Has no effect if
the device is not a keyboard.
Negative values for either rate or delay are illegal. A rate of zero
will disable any repeating (regardless of the value of delay). *)
method private virtual on_set_scroll_factor : [> `V2] t -> factor:Fixed.t -> unit
(** Set scroll factor.
Set the scroll factor for a pointer input device. Has no effect if the
device is not a pointer.
For example, a factor of 0.5 will make scrolling twice as slow while a
factor of 3.0 will make scrolling 3 times as fast.
Setting a scroll factor less than 0 is a protocol error. *)
method private virtual on_map_to_output : [> `V2] t -> output:([`Wl_output], [> Imports.Wl_output.versions], [`Server]) Proxy.t option ->
unit
(** Map input device to the given output.
Map the input device to the given output. Has no effect if the device is
not a pointer, touch, or tablet device.
If mapped to both an output and a rectangle, the rectangle has priority.
Passing null clears an existing mapping. *)
method private virtual on_map_to_rectangle : [> `V2] t -> x:int32 -> y:int32 -> width:int32 -> height:int32 -> unit
(** Map input device to the given rectangle.
Map the input device to the given rectangle in the global compositor
coordinate space. Has no effect if the device is not a pointer, touch,
or tablet device.
If mapped to both an output and a rectangle, the rectangle has priority.
Width and height must be greater than or equal to 0.
Passing 0 for width or height clears an existing mapping. *)
method min_version = 2l
end
end