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
//! 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 zwp_tablet_pad_ring_v2.frame
//! event.
use crate::protocol_helpers::prelude::*;
use super::super::all_types::*;
/// A zwp_tablet_pad_ring_v2 object.
///
/// See the documentation of [the module][self] for the interface description.
pub struct ZwpTabletPadRingV2 {
core: ObjectCore,
handler: HandlerHolder<dyn ZwpTabletPadRingV2Handler>,
}
struct DefaultHandler;
impl ZwpTabletPadRingV2Handler for DefaultHandler { }
impl ConcreteObject for ZwpTabletPadRingV2 {
const XML_VERSION: u32 = 2;
const INTERFACE: ObjectInterface = ObjectInterface::ZwpTabletPadRingV2;
const INTERFACE_NAME: &str = "zwp_tablet_pad_ring_v2";
}
impl ZwpTabletPadRingV2 {
/// Sets a new handler.
pub fn set_handler(&self, handler: impl ZwpTabletPadRingV2Handler) {
self.set_boxed_handler(Box::new(handler));
}
/// Sets a new, already boxed handler.
pub fn set_boxed_handler(&self, handler: Box<dyn ZwpTabletPadRingV2Handler>) {
if self.core.state.destroyed.get() {
return;
}
self.handler.set(Some(handler));
}
}
impl Debug for ZwpTabletPadRingV2 {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("ZwpTabletPadRingV2")
.field("server_obj_id", &self.core.server_obj_id.get())
.field("client_id", &self.core.client_id.get())
.field("client_obj_id", &self.core.client_obj_id.get())
.finish()
}
}
impl ZwpTabletPadRingV2 {
/// Since when the set_feedback message is available.
pub const MSG__SET_FEEDBACK__SINCE: u32 = 1;
/// set compositor feedback
///
/// Request that the compositor use the provided feedback string
/// associated with this ring. This request should be issued immediately
/// after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
/// group is received, or whenever the ring is mapped to a different
/// action. See zwp_tablet_pad_group_v2.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
/// zwp_tablet_pad_group_v2.mode_switch event received for the group of this
/// ring. Requests providing other serials than the most recent one will be
/// ignored.
///
/// # Arguments
///
/// - `description`: ring description
/// - `serial`: serial of the mode switch event
#[inline]
pub fn try_send_set_feedback(
&self,
description: &str,
serial: u32,
) -> Result<(), ObjectError> {
let (
arg0,
arg1,
) = (
description,
serial,
);
let core = self.core();
let Some(id) = core.server_obj_id.get() else {
return Err(ObjectError(ObjectErrorKind::ReceiverNoServerId));
};
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, id: u32, arg0: &str, arg1: u32) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}server <= zwp_tablet_pad_ring_v2#{}.set_feedback(description: {:?}, serial: {})\n", id, arg0, arg1);
state.log(args);
}
log(&self.core.state, id, arg0, arg1);
}
let Some(endpoint) = &self.core.state.server else {
return Ok(());
};
if !endpoint.flush_queued.replace(true) {
self.core.state.add_flushable_endpoint(endpoint, None);
}
let mut outgoing_ref = endpoint.outgoing.borrow_mut();
let outgoing = &mut *outgoing_ref;
let mut fmt = outgoing.formatter();
fmt.words([
id,
0,
]);
fmt.string(arg0);
fmt.words([
arg1,
]);
Ok(())
}
/// set compositor feedback
///
/// Request that the compositor use the provided feedback string
/// associated with this ring. This request should be issued immediately
/// after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
/// group is received, or whenever the ring is mapped to a different
/// action. See zwp_tablet_pad_group_v2.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
/// zwp_tablet_pad_group_v2.mode_switch event received for the group of this
/// ring. Requests providing other serials than the most recent one will be
/// ignored.
///
/// # Arguments
///
/// - `description`: ring description
/// - `serial`: serial of the mode switch event
#[inline]
pub fn send_set_feedback(
&self,
description: &str,
serial: u32,
) {
let res = self.try_send_set_feedback(
description,
serial,
);
if let Err(e) = res {
log_send("zwp_tablet_pad_ring_v2.set_feedback", &e);
}
}
/// Since when the destroy message is available.
pub const MSG__DESTROY__SINCE: u32 = 1;
/// destroy the ring object
///
/// This destroys the client's resource for this ring object.
#[inline]
pub fn try_send_destroy(
&self,
) -> Result<(), ObjectError> {
let core = self.core();
let Some(id) = core.server_obj_id.get() else {
return Err(ObjectError(ObjectErrorKind::ReceiverNoServerId));
};
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, id: u32) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}server <= zwp_tablet_pad_ring_v2#{}.destroy()\n", id);
state.log(args);
}
log(&self.core.state, id);
}
let Some(endpoint) = &self.core.state.server else {
return Ok(());
};
if !endpoint.flush_queued.replace(true) {
self.core.state.add_flushable_endpoint(endpoint, None);
}
let mut outgoing_ref = endpoint.outgoing.borrow_mut();
let outgoing = &mut *outgoing_ref;
let mut fmt = outgoing.formatter();
fmt.words([
id,
1,
]);
self.core.handle_server_destroy();
Ok(())
}
/// destroy the ring object
///
/// This destroys the client's resource for this ring object.
#[inline]
pub fn send_destroy(
&self,
) {
let res = self.try_send_destroy(
);
if let Err(e) = res {
log_send("zwp_tablet_pad_ring_v2.destroy", &e);
}
}
/// Since when the source message is available.
pub const MSG__SOURCE__SINCE: u32 = 1;
/// ring event source
///
/// Source information for ring events.
///
/// This event does not occur on its own. It is sent before a
/// zwp_tablet_pad_ring_v2.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
/// zwp_tablet_pad_ring_v2.source.finger, a zwp_tablet_pad_ring_v2.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.
///
/// # Arguments
///
/// - `source`: the event source
#[inline]
pub fn try_send_source(
&self,
source: ZwpTabletPadRingV2Source,
) -> Result<(), ObjectError> {
let (
arg0,
) = (
source,
);
let core = self.core();
let client_ref = core.client.borrow();
let Some(client) = &*client_ref else {
return Err(ObjectError(ObjectErrorKind::ReceiverNoClient));
};
let id = core.client_obj_id.get().unwrap_or(0);
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, client_id: u64, id: u32, arg0: ZwpTabletPadRingV2Source) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}client#{:<4} <= zwp_tablet_pad_ring_v2#{}.source(source: {:?})\n", client_id, id, arg0);
state.log(args);
}
log(&self.core.state, client.endpoint.id, id, arg0);
}
let endpoint = &client.endpoint;
if !endpoint.flush_queued.replace(true) {
self.core.state.add_flushable_endpoint(endpoint, Some(client));
}
let mut outgoing_ref = endpoint.outgoing.borrow_mut();
let outgoing = &mut *outgoing_ref;
let mut fmt = outgoing.formatter();
fmt.words([
id,
0,
arg0.0,
]);
Ok(())
}
/// ring event source
///
/// Source information for ring events.
///
/// This event does not occur on its own. It is sent before a
/// zwp_tablet_pad_ring_v2.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
/// zwp_tablet_pad_ring_v2.source.finger, a zwp_tablet_pad_ring_v2.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.
///
/// # Arguments
///
/// - `source`: the event source
#[inline]
pub fn send_source(
&self,
source: ZwpTabletPadRingV2Source,
) {
let res = self.try_send_source(
source,
);
if let Err(e) = res {
log_send("zwp_tablet_pad_ring_v2.source", &e);
}
}
/// Since when the angle message is available.
pub const MSG__ANGLE__SINCE: u32 = 1;
/// 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.
///
/// # Arguments
///
/// - `degrees`: the current angle in degrees
#[inline]
pub fn try_send_angle(
&self,
degrees: Fixed,
) -> Result<(), ObjectError> {
let (
arg0,
) = (
degrees,
);
let core = self.core();
let client_ref = core.client.borrow();
let Some(client) = &*client_ref else {
return Err(ObjectError(ObjectErrorKind::ReceiverNoClient));
};
let id = core.client_obj_id.get().unwrap_or(0);
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, client_id: u64, id: u32, arg0: Fixed) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}client#{:<4} <= zwp_tablet_pad_ring_v2#{}.angle(degrees: {})\n", client_id, id, arg0);
state.log(args);
}
log(&self.core.state, client.endpoint.id, id, arg0);
}
let endpoint = &client.endpoint;
if !endpoint.flush_queued.replace(true) {
self.core.state.add_flushable_endpoint(endpoint, Some(client));
}
let mut outgoing_ref = endpoint.outgoing.borrow_mut();
let outgoing = &mut *outgoing_ref;
let mut fmt = outgoing.formatter();
fmt.words([
id,
1,
arg0.to_wire() as u32,
]);
Ok(())
}
/// 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.
///
/// # Arguments
///
/// - `degrees`: the current angle in degrees
#[inline]
pub fn send_angle(
&self,
degrees: Fixed,
) {
let res = self.try_send_angle(
degrees,
);
if let Err(e) = res {
log_send("zwp_tablet_pad_ring_v2.angle", &e);
}
}
/// Since when the stop message is available.
pub const MSG__STOP__SINCE: u32 = 1;
/// interaction stopped
///
/// Stop notification for ring events.
///
/// For some zwp_tablet_pad_ring_v2.source types, a zwp_tablet_pad_ring_v2.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 zwp_tablet_pad_ring_v2.source documentation for information on
/// when this event may be generated.
///
/// Any zwp_tablet_pad_ring_v2.angle events with the same source after this
/// event should be considered as the start of a new interaction.
#[inline]
pub fn try_send_stop(
&self,
) -> Result<(), ObjectError> {
let core = self.core();
let client_ref = core.client.borrow();
let Some(client) = &*client_ref else {
return Err(ObjectError(ObjectErrorKind::ReceiverNoClient));
};
let id = core.client_obj_id.get().unwrap_or(0);
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, client_id: u64, id: u32) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}client#{:<4} <= zwp_tablet_pad_ring_v2#{}.stop()\n", client_id, id);
state.log(args);
}
log(&self.core.state, client.endpoint.id, id);
}
let endpoint = &client.endpoint;
if !endpoint.flush_queued.replace(true) {
self.core.state.add_flushable_endpoint(endpoint, Some(client));
}
let mut outgoing_ref = endpoint.outgoing.borrow_mut();
let outgoing = &mut *outgoing_ref;
let mut fmt = outgoing.formatter();
fmt.words([
id,
2,
]);
Ok(())
}
/// interaction stopped
///
/// Stop notification for ring events.
///
/// For some zwp_tablet_pad_ring_v2.source types, a zwp_tablet_pad_ring_v2.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 zwp_tablet_pad_ring_v2.source documentation for information on
/// when this event may be generated.
///
/// Any zwp_tablet_pad_ring_v2.angle events with the same source after this
/// event should be considered as the start of a new interaction.
#[inline]
pub fn send_stop(
&self,
) {
let res = self.try_send_stop(
);
if let Err(e) = res {
log_send("zwp_tablet_pad_ring_v2.stop", &e);
}
}
/// Since when the frame message is available.
pub const MSG__FRAME__SINCE: u32 = 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 zwp_tablet_pad_ring_v2 events before a zwp_tablet_pad_ring_v2.frame event belong
/// logically together. For example, on termination of a finger interaction
/// on a ring the compositor will send a zwp_tablet_pad_ring_v2.source event,
/// a zwp_tablet_pad_ring_v2.stop event and a zwp_tablet_pad_ring_v2.frame event.
///
/// A zwp_tablet_pad_ring_v2.frame event is sent for every logical event
/// group, even if the group only contains a single zwp_tablet_pad_ring_v2
/// event. Specifically, a client may get a sequence: angle, frame,
/// angle, frame, etc.
///
/// # Arguments
///
/// - `time`: timestamp with millisecond granularity
#[inline]
pub fn try_send_frame(
&self,
time: u32,
) -> Result<(), ObjectError> {
let (
arg0,
) = (
time,
);
let core = self.core();
let client_ref = core.client.borrow();
let Some(client) = &*client_ref else {
return Err(ObjectError(ObjectErrorKind::ReceiverNoClient));
};
let id = core.client_obj_id.get().unwrap_or(0);
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, client_id: u64, id: u32, arg0: u32) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}client#{:<4} <= zwp_tablet_pad_ring_v2#{}.frame(time: {})\n", client_id, id, arg0);
state.log(args);
}
log(&self.core.state, client.endpoint.id, id, arg0);
}
let endpoint = &client.endpoint;
if !endpoint.flush_queued.replace(true) {
self.core.state.add_flushable_endpoint(endpoint, Some(client));
}
let mut outgoing_ref = endpoint.outgoing.borrow_mut();
let outgoing = &mut *outgoing_ref;
let mut fmt = outgoing.formatter();
fmt.words([
id,
3,
arg0,
]);
Ok(())
}
/// 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 zwp_tablet_pad_ring_v2 events before a zwp_tablet_pad_ring_v2.frame event belong
/// logically together. For example, on termination of a finger interaction
/// on a ring the compositor will send a zwp_tablet_pad_ring_v2.source event,
/// a zwp_tablet_pad_ring_v2.stop event and a zwp_tablet_pad_ring_v2.frame event.
///
/// A zwp_tablet_pad_ring_v2.frame event is sent for every logical event
/// group, even if the group only contains a single zwp_tablet_pad_ring_v2
/// event. Specifically, a client may get a sequence: angle, frame,
/// angle, frame, etc.
///
/// # Arguments
///
/// - `time`: timestamp with millisecond granularity
#[inline]
pub fn send_frame(
&self,
time: u32,
) {
let res = self.try_send_frame(
time,
);
if let Err(e) = res {
log_send("zwp_tablet_pad_ring_v2.frame", &e);
}
}
}
/// A message handler for [`ZwpTabletPadRingV2`] proxies.
pub trait ZwpTabletPadRingV2Handler: Any {
/// Event handler for wl_display.delete_id messages deleting the ID of this object.
///
/// The default handler forwards the event to the client, if any.
#[inline]
fn delete_id(&mut self, slf: &Rc<ZwpTabletPadRingV2>) {
slf.core.delete_id();
}
/// set compositor feedback
///
/// Request that the compositor use the provided feedback string
/// associated with this ring. This request should be issued immediately
/// after a zwp_tablet_pad_group_v2.mode_switch event from the corresponding
/// group is received, or whenever the ring is mapped to a different
/// action. See zwp_tablet_pad_group_v2.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
/// zwp_tablet_pad_group_v2.mode_switch event received for the group of this
/// ring. Requests providing other serials than the most recent one will be
/// ignored.
///
/// # Arguments
///
/// - `description`: ring description
/// - `serial`: serial of the mode switch event
#[inline]
fn handle_set_feedback(
&mut self,
slf: &Rc<ZwpTabletPadRingV2>,
description: &str,
serial: u32,
) {
if !slf.core.forward_to_server.get() {
return;
}
let res = slf.try_send_set_feedback(
description,
serial,
);
if let Err(e) = res {
log_forward("zwp_tablet_pad_ring_v2.set_feedback", &e);
}
}
/// destroy the ring object
///
/// This destroys the client's resource for this ring object.
#[inline]
fn handle_destroy(
&mut self,
slf: &Rc<ZwpTabletPadRingV2>,
) {
if !slf.core.forward_to_server.get() {
return;
}
let res = slf.try_send_destroy(
);
if let Err(e) = res {
log_forward("zwp_tablet_pad_ring_v2.destroy", &e);
}
}
/// ring event source
///
/// Source information for ring events.
///
/// This event does not occur on its own. It is sent before a
/// zwp_tablet_pad_ring_v2.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
/// zwp_tablet_pad_ring_v2.source.finger, a zwp_tablet_pad_ring_v2.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.
///
/// # Arguments
///
/// - `source`: the event source
#[inline]
fn handle_source(
&mut self,
slf: &Rc<ZwpTabletPadRingV2>,
source: ZwpTabletPadRingV2Source,
) {
if !slf.core.forward_to_client.get() {
return;
}
let res = slf.try_send_source(
source,
);
if let Err(e) = res {
log_forward("zwp_tablet_pad_ring_v2.source", &e);
}
}
/// 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.
///
/// # Arguments
///
/// - `degrees`: the current angle in degrees
#[inline]
fn handle_angle(
&mut self,
slf: &Rc<ZwpTabletPadRingV2>,
degrees: Fixed,
) {
if !slf.core.forward_to_client.get() {
return;
}
let res = slf.try_send_angle(
degrees,
);
if let Err(e) = res {
log_forward("zwp_tablet_pad_ring_v2.angle", &e);
}
}
/// interaction stopped
///
/// Stop notification for ring events.
///
/// For some zwp_tablet_pad_ring_v2.source types, a zwp_tablet_pad_ring_v2.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 zwp_tablet_pad_ring_v2.source documentation for information on
/// when this event may be generated.
///
/// Any zwp_tablet_pad_ring_v2.angle events with the same source after this
/// event should be considered as the start of a new interaction.
#[inline]
fn handle_stop(
&mut self,
slf: &Rc<ZwpTabletPadRingV2>,
) {
if !slf.core.forward_to_client.get() {
return;
}
let res = slf.try_send_stop(
);
if let Err(e) = res {
log_forward("zwp_tablet_pad_ring_v2.stop", &e);
}
}
/// 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 zwp_tablet_pad_ring_v2 events before a zwp_tablet_pad_ring_v2.frame event belong
/// logically together. For example, on termination of a finger interaction
/// on a ring the compositor will send a zwp_tablet_pad_ring_v2.source event,
/// a zwp_tablet_pad_ring_v2.stop event and a zwp_tablet_pad_ring_v2.frame event.
///
/// A zwp_tablet_pad_ring_v2.frame event is sent for every logical event
/// group, even if the group only contains a single zwp_tablet_pad_ring_v2
/// event. Specifically, a client may get a sequence: angle, frame,
/// angle, frame, etc.
///
/// # Arguments
///
/// - `time`: timestamp with millisecond granularity
#[inline]
fn handle_frame(
&mut self,
slf: &Rc<ZwpTabletPadRingV2>,
time: u32,
) {
if !slf.core.forward_to_client.get() {
return;
}
let res = slf.try_send_frame(
time,
);
if let Err(e) = res {
log_forward("zwp_tablet_pad_ring_v2.frame", &e);
}
}
}
impl ObjectPrivate for ZwpTabletPadRingV2 {
fn new(state: &Rc<State>, version: u32) -> Rc<Self> {
Rc::<Self>::new_cyclic(|slf| Self {
core: ObjectCore::new(state, slf.clone(), ObjectInterface::ZwpTabletPadRingV2, version),
handler: Default::default(),
})
}
fn delete_id(self: Rc<Self>) -> Result<(), (ObjectError, Rc<dyn Object>)> {
let Some(mut handler) = self.handler.try_borrow_mut() else {
return Err((ObjectError(ObjectErrorKind::HandlerBorrowed), self));
};
if let Some(handler) = &mut *handler {
handler.delete_id(&self);
} else {
self.core.delete_id();
}
Ok(())
}
fn handle_request(self: Rc<Self>, client: &Rc<Client>, msg: &[u32], fds: &mut VecDeque<Rc<OwnedFd>>) -> Result<(), ObjectError> {
let Some(mut handler) = self.handler.try_borrow_mut() else {
return Err(ObjectError(ObjectErrorKind::HandlerBorrowed));
};
let handler = &mut *handler;
match msg[1] & 0xffff {
0 => {
let mut offset = 2;
let arg0;
(arg0, offset) = parse_string::<NonNullString>(msg, offset, "description")?;
let Some(&arg1) = msg.get(offset) else {
return Err(ObjectError(ObjectErrorKind::MissingArgument("serial")));
};
offset += 1;
if offset != msg.len() {
return Err(ObjectError(ObjectErrorKind::TrailingBytes));
}
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, client_id: u64, id: u32, arg0: &str, arg1: u32) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}client#{:<4} -> zwp_tablet_pad_ring_v2#{}.set_feedback(description: {:?}, serial: {})\n", client_id, id, arg0, arg1);
state.log(args);
}
log(&self.core.state, client.endpoint.id, msg[0], arg0, arg1);
}
if let Some(handler) = handler {
(**handler).handle_set_feedback(&self, arg0, arg1);
} else {
DefaultHandler.handle_set_feedback(&self, arg0, arg1);
}
}
1 => {
if msg.len() != 2 {
return Err(ObjectError(ObjectErrorKind::WrongMessageSize(msg.len() as u32 * 4, 8)));
}
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, client_id: u64, id: u32) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}client#{:<4} -> zwp_tablet_pad_ring_v2#{}.destroy()\n", client_id, id);
state.log(args);
}
log(&self.core.state, client.endpoint.id, msg[0]);
}
self.core.handle_client_destroy();
if let Some(handler) = handler {
(**handler).handle_destroy(&self);
} else {
DefaultHandler.handle_destroy(&self);
}
}
n => {
let _ = client;
let _ = msg;
let _ = fds;
let _ = handler;
return Err(ObjectError(ObjectErrorKind::UnknownMessageId(n)));
}
}
Ok(())
}
fn handle_event(self: Rc<Self>, server: &Endpoint, msg: &[u32], fds: &mut VecDeque<Rc<OwnedFd>>) -> Result<(), ObjectError> {
let Some(mut handler) = self.handler.try_borrow_mut() else {
return Err(ObjectError(ObjectErrorKind::HandlerBorrowed));
};
let handler = &mut *handler;
match msg[1] & 0xffff {
0 => {
let [
arg0,
] = msg[2..] else {
return Err(ObjectError(ObjectErrorKind::WrongMessageSize(msg.len() as u32 * 4, 12)));
};
let arg0 = ZwpTabletPadRingV2Source(arg0);
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, id: u32, arg0: ZwpTabletPadRingV2Source) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}server -> zwp_tablet_pad_ring_v2#{}.source(source: {:?})\n", id, arg0);
state.log(args);
}
log(&self.core.state, msg[0], arg0);
}
if let Some(handler) = handler {
(**handler).handle_source(&self, arg0);
} else {
DefaultHandler.handle_source(&self, arg0);
}
}
1 => {
let [
arg0,
] = msg[2..] else {
return Err(ObjectError(ObjectErrorKind::WrongMessageSize(msg.len() as u32 * 4, 12)));
};
let arg0 = Fixed::from_wire(arg0 as i32);
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, id: u32, arg0: Fixed) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}server -> zwp_tablet_pad_ring_v2#{}.angle(degrees: {})\n", id, arg0);
state.log(args);
}
log(&self.core.state, msg[0], arg0);
}
if let Some(handler) = handler {
(**handler).handle_angle(&self, arg0);
} else {
DefaultHandler.handle_angle(&self, arg0);
}
}
2 => {
if msg.len() != 2 {
return Err(ObjectError(ObjectErrorKind::WrongMessageSize(msg.len() as u32 * 4, 8)));
}
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, id: u32) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}server -> zwp_tablet_pad_ring_v2#{}.stop()\n", id);
state.log(args);
}
log(&self.core.state, msg[0]);
}
if let Some(handler) = handler {
(**handler).handle_stop(&self);
} else {
DefaultHandler.handle_stop(&self);
}
}
3 => {
let [
arg0,
] = msg[2..] else {
return Err(ObjectError(ObjectErrorKind::WrongMessageSize(msg.len() as u32 * 4, 12)));
};
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, id: u32, arg0: u32) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}server -> zwp_tablet_pad_ring_v2#{}.frame(time: {})\n", id, arg0);
state.log(args);
}
log(&self.core.state, msg[0], arg0);
}
if let Some(handler) = handler {
(**handler).handle_frame(&self, arg0);
} else {
DefaultHandler.handle_frame(&self, arg0);
}
}
n => {
let _ = server;
let _ = msg;
let _ = fds;
let _ = handler;
return Err(ObjectError(ObjectErrorKind::UnknownMessageId(n)));
}
}
Ok(())
}
fn get_request_name(&self, id: u32) -> Option<&'static str> {
let name = match id {
0 => "set_feedback",
1 => "destroy",
_ => return None,
};
Some(name)
}
fn get_event_name(&self, id: u32) -> Option<&'static str> {
let name = match id {
0 => "source",
1 => "angle",
2 => "stop",
3 => "frame",
_ => return None,
};
Some(name)
}
}
impl Object for ZwpTabletPadRingV2 {
fn core(&self) -> &ObjectCore {
&self.core
}
fn unset_handler(&self) {
self.handler.set(None);
}
fn get_handler_any_ref(&self) -> Result<HandlerRef<'_, dyn Any>, HandlerAccessError> {
let borrowed = self.handler.try_borrow().ok_or(HandlerAccessError::AlreadyBorrowed)?;
if borrowed.is_none() {
return Err(HandlerAccessError::NoHandler);
}
Ok(HandlerRef::map(borrowed, |handler| &**handler.as_ref().unwrap() as &dyn Any))
}
fn get_handler_any_mut(&self) -> Result<HandlerMut<'_, dyn Any>, HandlerAccessError> {
let borrowed = self.handler.try_borrow_mut().ok_or(HandlerAccessError::AlreadyBorrowed)?;
if borrowed.is_none() {
return Err(HandlerAccessError::NoHandler);
}
Ok(HandlerMut::map(borrowed, |handler| &mut **handler.as_mut().unwrap() as &mut dyn Any))
}
}
impl ZwpTabletPadRingV2 {
/// Since when the source.finger enum variant is available.
pub const ENM__SOURCE_FINGER__SINCE: u32 = 1;
}
/// ring axis source
///
/// Describes the source types for ring events. This indicates to the
/// client how a ring event was physically generated; a client may
/// adjust the user interface accordingly. For example, events
/// from a "finger" source may trigger kinetic scrolling.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct ZwpTabletPadRingV2Source(pub u32);
impl ZwpTabletPadRingV2Source {
/// finger
pub const FINGER: Self = Self(1);
}
impl Debug for ZwpTabletPadRingV2Source {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
let name = match *self {
Self::FINGER => "FINGER",
_ => return Debug::fmt(&self.0, f),
};
f.write_str(name)
}
}