wl-proxy 0.1.2

Wayland connection proxy
Documentation
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
//! content protection interface to a wl_surface
//!
//! An additional interface to a wl_surface object, which allows a client to
//! request the minimum level of content-protection, request to change the
//! visibility of their contents, and receive notifications about changes in
//! content-protection.
//!
//! A protected surface has a 'status' associated with it, that indicates
//! what type of protection it is currently providing, specified by
//! content-type. Updates to this status are sent to the client
//! via the 'status' event. Before the first status event is sent, the client
//! should assume that the status is 'unprotected'.
//!
//! A client can request a content protection level to be the minimum for an
//! output to be considered secure, using the 'set_type' request.
//! It is responsibility of the client to monitor the actual
//! content-protection level achieved via the 'status' event, and make
//! decisions as to what content to show based on this.
//!
//! The server should make its best effort to achieve the desired
//! content-protection level on all of the outputs the client's contents are
//! being displayed on. Any changes to the content protection status should be
//! reported to the client, even if they are below the requested
//! content-protection level. If the client's contents are being displayed on
//! multiple outputs, the lowest content protection level achieved should be
//! reported.
//!
//! A client can also request that its content only be displayed on outputs
//! that are considered secure. The 'enforce/relax' requests can achieve this.
//! In enforce mode, the content is censored for non-secure outputs.
//! The implementation of censored-visibility is compositor-defined.
//! In relax mode there are no such limitation. On an attempt to show the
//! client on unsecured output, compositor would keep on showing the content
//! and send the 'status' event to the client. Client can take a call to
//! downgrade the content.
//!
//! If the wl_surface associated with the protected_surface is destroyed,
//! the protected_surface becomes inert.

use crate::protocol_helpers::prelude::*;
use super::super::all_types::*;

/// A weston_protected_surface object.
///
/// See the documentation of [the module][self] for the interface description.
pub struct WestonProtectedSurface {
    core: ObjectCore,
    handler: HandlerHolder<dyn WestonProtectedSurfaceHandler>,
}

struct DefaultHandler;

impl WestonProtectedSurfaceHandler for DefaultHandler { }

impl ConcreteObject for WestonProtectedSurface {
    const XML_VERSION: u32 = 1;
    const INTERFACE: ObjectInterface = ObjectInterface::WestonProtectedSurface;
    const INTERFACE_NAME: &str = "weston_protected_surface";
}

impl WestonProtectedSurface {
    /// Sets a new handler.
    pub fn set_handler(&self, handler: impl WestonProtectedSurfaceHandler) {
        self.set_boxed_handler(Box::new(handler));
    }

    /// Sets a new, already boxed handler.
    pub fn set_boxed_handler(&self, handler: Box<dyn WestonProtectedSurfaceHandler>) {
        if self.core.state.destroyed.get() {
            return;
        }
        self.handler.set(Some(handler));
    }
}

impl Debug for WestonProtectedSurface {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("WestonProtectedSurface")
            .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 WestonProtectedSurface {
    /// Since when the destroy message is available.
    pub const MSG__DESTROY__SINCE: u32 = 1;

    /// remove security from the surface
    ///
    /// If the protected_surface is destroyed, the wl_surface desired protection
    /// level returns to unprotected, as if set_type request was sent with type
    /// as 'unprotected'.
    #[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      <= weston_protected_surface#{}.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,
            0,
        ]);
        self.core.handle_server_destroy();
        Ok(())
    }

    /// remove security from the surface
    ///
    /// If the protected_surface is destroyed, the wl_surface desired protection
    /// level returns to unprotected, as if set_type request was sent with type
    /// as 'unprotected'.
    #[inline]
    pub fn send_destroy(
        &self,
    ) {
        let res = self.try_send_destroy(
        );
        if let Err(e) = res {
            log_send("weston_protected_surface.destroy", &e);
        }
    }

    /// Since when the set_type message is available.
    pub const MSG__SET_TYPE__SINCE: u32 = 1;

    /// set the acceptable level of content protection
    ///
    /// Informs the server about the type of content. The level of
    /// content-protection depends upon the content-type set by the client
    /// through this request. Initially, this is set to 'unprotected'.
    ///
    /// If the requested value is not a valid content_type enum value, the
    /// 'invalid_type' protocol error is raised. It is not an error to request
    /// a valid protection type the compositor does not implement or cannot
    /// achieve.
    ///
    /// The requested content protection is double-buffered, see
    /// wl_surface.commit.
    ///
    /// # Arguments
    ///
    /// - `r#type`: the desired type of content protection
    #[inline]
    pub fn try_send_set_type(
        &self,
        r#type: WestonProtectedSurfaceType,
    ) -> Result<(), ObjectError> {
        let (
            arg0,
        ) = (
            r#type,
        );
        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: WestonProtectedSurfaceType) {
                let (millis, micros) = time_since_epoch();
                let prefix = &state.log_prefix;
                let args = format_args!("[{millis:7}.{micros:03}] {prefix}server      <= weston_protected_surface#{}.set_type(type: {:?})\n", id, arg0);
                state.log(args);
            }
            log(&self.core.state, id, arg0);
        }
        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,
            arg0.0,
        ]);
        Ok(())
    }

    /// set the acceptable level of content protection
    ///
    /// Informs the server about the type of content. The level of
    /// content-protection depends upon the content-type set by the client
    /// through this request. Initially, this is set to 'unprotected'.
    ///
    /// If the requested value is not a valid content_type enum value, the
    /// 'invalid_type' protocol error is raised. It is not an error to request
    /// a valid protection type the compositor does not implement or cannot
    /// achieve.
    ///
    /// The requested content protection is double-buffered, see
    /// wl_surface.commit.
    ///
    /// # Arguments
    ///
    /// - `r#type`: the desired type of content protection
    #[inline]
    pub fn send_set_type(
        &self,
        r#type: WestonProtectedSurfaceType,
    ) {
        let res = self.try_send_set_type(
            r#type,
        );
        if let Err(e) = res {
            log_send("weston_protected_surface.set_type", &e);
        }
    }

    /// Since when the enforce message is available.
    pub const MSG__ENFORCE__SINCE: u32 = 1;

    /// enforce censored-visibility constrain
    ///
    /// Censor the visibility of the wl_surface contents on non-secure outputs.
    /// See weston_protected_surface for the description.
    ///
    /// The force constrain mode is double-buffered, see wl_surface.commit
    #[inline]
    pub fn try_send_enforce(
        &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      <= weston_protected_surface#{}.enforce()\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,
            2,
        ]);
        Ok(())
    }

    /// enforce censored-visibility constrain
    ///
    /// Censor the visibility of the wl_surface contents on non-secure outputs.
    /// See weston_protected_surface for the description.
    ///
    /// The force constrain mode is double-buffered, see wl_surface.commit
    #[inline]
    pub fn send_enforce(
        &self,
    ) {
        let res = self.try_send_enforce(
        );
        if let Err(e) = res {
            log_send("weston_protected_surface.enforce", &e);
        }
    }

    /// Since when the relax message is available.
    pub const MSG__RELAX__SINCE: u32 = 1;

    /// relax the censored-visibility constrain
    ///
    /// Do not enforce censored-visibility of the wl_surface contents on
    /// non-secure-outputs. See weston_protected_surface for the description.
    ///
    /// The relax mode is selected by default, if no explicit request is made
    /// for enforcing the censored-visibility.
    ///
    /// The relax mode is double-buffered, see wl_surface.commit
    #[inline]
    pub fn try_send_relax(
        &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      <= weston_protected_surface#{}.relax()\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,
            3,
        ]);
        Ok(())
    }

    /// relax the censored-visibility constrain
    ///
    /// Do not enforce censored-visibility of the wl_surface contents on
    /// non-secure-outputs. See weston_protected_surface for the description.
    ///
    /// The relax mode is selected by default, if no explicit request is made
    /// for enforcing the censored-visibility.
    ///
    /// The relax mode is double-buffered, see wl_surface.commit
    #[inline]
    pub fn send_relax(
        &self,
    ) {
        let res = self.try_send_relax(
        );
        if let Err(e) = res {
            log_send("weston_protected_surface.relax", &e);
        }
    }

    /// Since when the status message is available.
    pub const MSG__STATUS__SINCE: u32 = 1;

    /// security status changed
    ///
    /// This event is sent to the client to inform about the actual protection
    /// level for its surface in the relax mode.
    ///
    /// The 'type' argument indicates what that current level of content
    /// protection that the server has currently established.
    ///
    /// The 'status' event is first sent, when a weston_protected_surface is
    /// created.
    ///
    /// Until this event is sent for the first time, the client should assume
    /// that its contents are not secure, and the type is 'unprotected'.
    ///
    /// Possible reasons the content protection status can change is due to
    /// change in censored-visibility mode from enforced to relaxed, a new
    /// connector being added, movement of window to another output, or,
    /// the client attaching a buffer too large for what the server may secure.
    /// However, it is not limited to these reasons.
    ///
    /// A client may want to listen to this event and lower the resolution of
    /// their content until it can successfully be shown securely.
    ///
    /// In case of "enforce" mode, the client will not get any status event.
    /// If the mode is then changed to "relax", the client will receive the
    /// status event.
    ///
    /// # Arguments
    ///
    /// - `r#type`: the current content protection level
    #[inline]
    pub fn try_send_status(
        &self,
        r#type: WestonProtectedSurfaceType,
    ) -> Result<(), ObjectError> {
        let (
            arg0,
        ) = (
            r#type,
        );
        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: WestonProtectedSurfaceType) {
                let (millis, micros) = time_since_epoch();
                let prefix = &state.log_prefix;
                let args = format_args!("[{millis:7}.{micros:03}] {prefix}client#{:<4} <= weston_protected_surface#{}.status(type: {:?})\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(())
    }

    /// security status changed
    ///
    /// This event is sent to the client to inform about the actual protection
    /// level for its surface in the relax mode.
    ///
    /// The 'type' argument indicates what that current level of content
    /// protection that the server has currently established.
    ///
    /// The 'status' event is first sent, when a weston_protected_surface is
    /// created.
    ///
    /// Until this event is sent for the first time, the client should assume
    /// that its contents are not secure, and the type is 'unprotected'.
    ///
    /// Possible reasons the content protection status can change is due to
    /// change in censored-visibility mode from enforced to relaxed, a new
    /// connector being added, movement of window to another output, or,
    /// the client attaching a buffer too large for what the server may secure.
    /// However, it is not limited to these reasons.
    ///
    /// A client may want to listen to this event and lower the resolution of
    /// their content until it can successfully be shown securely.
    ///
    /// In case of "enforce" mode, the client will not get any status event.
    /// If the mode is then changed to "relax", the client will receive the
    /// status event.
    ///
    /// # Arguments
    ///
    /// - `r#type`: the current content protection level
    #[inline]
    pub fn send_status(
        &self,
        r#type: WestonProtectedSurfaceType,
    ) {
        let res = self.try_send_status(
            r#type,
        );
        if let Err(e) = res {
            log_send("weston_protected_surface.status", &e);
        }
    }
}

/// A message handler for [`WestonProtectedSurface`] proxies.
pub trait WestonProtectedSurfaceHandler: 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<WestonProtectedSurface>) {
        slf.core.delete_id();
    }

    /// remove security from the surface
    ///
    /// If the protected_surface is destroyed, the wl_surface desired protection
    /// level returns to unprotected, as if set_type request was sent with type
    /// as 'unprotected'.
    #[inline]
    fn handle_destroy(
        &mut self,
        slf: &Rc<WestonProtectedSurface>,
    ) {
        if !slf.core.forward_to_server.get() {
            return;
        }
        let res = slf.try_send_destroy(
        );
        if let Err(e) = res {
            log_forward("weston_protected_surface.destroy", &e);
        }
    }

    /// set the acceptable level of content protection
    ///
    /// Informs the server about the type of content. The level of
    /// content-protection depends upon the content-type set by the client
    /// through this request. Initially, this is set to 'unprotected'.
    ///
    /// If the requested value is not a valid content_type enum value, the
    /// 'invalid_type' protocol error is raised. It is not an error to request
    /// a valid protection type the compositor does not implement or cannot
    /// achieve.
    ///
    /// The requested content protection is double-buffered, see
    /// wl_surface.commit.
    ///
    /// # Arguments
    ///
    /// - `r#type`: the desired type of content protection
    #[inline]
    fn handle_set_type(
        &mut self,
        slf: &Rc<WestonProtectedSurface>,
        r#type: WestonProtectedSurfaceType,
    ) {
        if !slf.core.forward_to_server.get() {
            return;
        }
        let res = slf.try_send_set_type(
            r#type,
        );
        if let Err(e) = res {
            log_forward("weston_protected_surface.set_type", &e);
        }
    }

    /// enforce censored-visibility constrain
    ///
    /// Censor the visibility of the wl_surface contents on non-secure outputs.
    /// See weston_protected_surface for the description.
    ///
    /// The force constrain mode is double-buffered, see wl_surface.commit
    #[inline]
    fn handle_enforce(
        &mut self,
        slf: &Rc<WestonProtectedSurface>,
    ) {
        if !slf.core.forward_to_server.get() {
            return;
        }
        let res = slf.try_send_enforce(
        );
        if let Err(e) = res {
            log_forward("weston_protected_surface.enforce", &e);
        }
    }

    /// relax the censored-visibility constrain
    ///
    /// Do not enforce censored-visibility of the wl_surface contents on
    /// non-secure-outputs. See weston_protected_surface for the description.
    ///
    /// The relax mode is selected by default, if no explicit request is made
    /// for enforcing the censored-visibility.
    ///
    /// The relax mode is double-buffered, see wl_surface.commit
    #[inline]
    fn handle_relax(
        &mut self,
        slf: &Rc<WestonProtectedSurface>,
    ) {
        if !slf.core.forward_to_server.get() {
            return;
        }
        let res = slf.try_send_relax(
        );
        if let Err(e) = res {
            log_forward("weston_protected_surface.relax", &e);
        }
    }

    /// security status changed
    ///
    /// This event is sent to the client to inform about the actual protection
    /// level for its surface in the relax mode.
    ///
    /// The 'type' argument indicates what that current level of content
    /// protection that the server has currently established.
    ///
    /// The 'status' event is first sent, when a weston_protected_surface is
    /// created.
    ///
    /// Until this event is sent for the first time, the client should assume
    /// that its contents are not secure, and the type is 'unprotected'.
    ///
    /// Possible reasons the content protection status can change is due to
    /// change in censored-visibility mode from enforced to relaxed, a new
    /// connector being added, movement of window to another output, or,
    /// the client attaching a buffer too large for what the server may secure.
    /// However, it is not limited to these reasons.
    ///
    /// A client may want to listen to this event and lower the resolution of
    /// their content until it can successfully be shown securely.
    ///
    /// In case of "enforce" mode, the client will not get any status event.
    /// If the mode is then changed to "relax", the client will receive the
    /// status event.
    ///
    /// # Arguments
    ///
    /// - `r#type`: the current content protection level
    #[inline]
    fn handle_status(
        &mut self,
        slf: &Rc<WestonProtectedSurface>,
        r#type: WestonProtectedSurfaceType,
    ) {
        if !slf.core.forward_to_client.get() {
            return;
        }
        let res = slf.try_send_status(
            r#type,
        );
        if let Err(e) = res {
            log_forward("weston_protected_surface.status", &e);
        }
    }
}

impl ObjectPrivate for WestonProtectedSurface {
    fn new(state: &Rc<State>, version: u32) -> Rc<Self> {
        Rc::<Self>::new_cyclic(|slf| Self {
            core: ObjectCore::new(state, slf.clone(), ObjectInterface::WestonProtectedSurface, 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 => {
                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} -> weston_protected_surface#{}.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);
                }
            }
            1 => {
                let [
                    arg0,
                ] = msg[2..] else {
                    return Err(ObjectError(ObjectErrorKind::WrongMessageSize(msg.len() as u32 * 4, 12)));
                };
                let arg0 = WestonProtectedSurfaceType(arg0);
                #[cfg(feature = "logging")]
                if self.core.state.log {
                    #[cold]
                    fn log(state: &State, client_id: u64, id: u32, arg0: WestonProtectedSurfaceType) {
                        let (millis, micros) = time_since_epoch();
                        let prefix = &state.log_prefix;
                        let args = format_args!("[{millis:7}.{micros:03}] {prefix}client#{:<4} -> weston_protected_surface#{}.set_type(type: {:?})\n", client_id, id, arg0);
                        state.log(args);
                    }
                    log(&self.core.state, client.endpoint.id, msg[0], arg0);
                }
                if let Some(handler) = handler {
                    (**handler).handle_set_type(&self, arg0);
                } else {
                    DefaultHandler.handle_set_type(&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, 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} -> weston_protected_surface#{}.enforce()\n", client_id, id);
                        state.log(args);
                    }
                    log(&self.core.state, client.endpoint.id, msg[0]);
                }
                if let Some(handler) = handler {
                    (**handler).handle_enforce(&self);
                } else {
                    DefaultHandler.handle_enforce(&self);
                }
            }
            3 => {
                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} -> weston_protected_surface#{}.relax()\n", client_id, id);
                        state.log(args);
                    }
                    log(&self.core.state, client.endpoint.id, msg[0]);
                }
                if let Some(handler) = handler {
                    (**handler).handle_relax(&self);
                } else {
                    DefaultHandler.handle_relax(&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 = WestonProtectedSurfaceType(arg0);
                #[cfg(feature = "logging")]
                if self.core.state.log {
                    #[cold]
                    fn log(state: &State, id: u32, arg0: WestonProtectedSurfaceType) {
                        let (millis, micros) = time_since_epoch();
                        let prefix = &state.log_prefix;
                        let args = format_args!("[{millis:7}.{micros:03}] {prefix}server      -> weston_protected_surface#{}.status(type: {:?})\n", id, arg0);
                        state.log(args);
                    }
                    log(&self.core.state, msg[0], arg0);
                }
                if let Some(handler) = handler {
                    (**handler).handle_status(&self, arg0);
                } else {
                    DefaultHandler.handle_status(&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 => "destroy",
            1 => "set_type",
            2 => "enforce",
            3 => "relax",
            _ => return None,
        };
        Some(name)
    }

    fn get_event_name(&self, id: u32) -> Option<&'static str> {
        let name = match id {
            0 => "status",
            _ => return None,
        };
        Some(name)
    }
}

impl Object for WestonProtectedSurface {
    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 WestonProtectedSurface {
    /// Since when the error.invalid_type enum variant is available.
    pub const ENM__ERROR_INVALID_TYPE__SINCE: u32 = 1;

    /// Since when the type.unprotected enum variant is available.
    pub const ENM__TYPE_UNPROTECTED__SINCE: u32 = 1;
    /// Since when the type.hdcp_0 enum variant is available.
    pub const ENM__TYPE_HDCP_0__SINCE: u32 = 1;
    /// Since when the type.hdcp_1 enum variant is available.
    pub const ENM__TYPE_HDCP_1__SINCE: u32 = 1;
}

#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct WestonProtectedSurfaceError(pub u32);

impl WestonProtectedSurfaceError {
    /// provided type was not valid
    pub const INVALID_TYPE: Self = Self(0);
}

impl Debug for WestonProtectedSurfaceError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let name = match *self {
            Self::INVALID_TYPE => "INVALID_TYPE",
            _ => return Debug::fmt(&self.0, f),
        };
        f.write_str(name)
    }
}

/// content types
///
/// Description of a particular type of content protection.
///
/// A server may not necessarily support all of these types.
///
/// Note that there is no ordering between enum members unless specified.
/// Over time, different types of content protection may be added, which
/// may be considered less secure than what is already here.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct WestonProtectedSurfaceType(pub u32);

impl WestonProtectedSurfaceType {
    /// no protection required
    pub const UNPROTECTED: Self = Self(0);

    /// HDCP type 0
    pub const HDCP_0: Self = Self(1);

    /// HDCP type 1. This is a more secure than HDCP type 0.
    pub const HDCP_1: Self = Self(2);
}

impl Debug for WestonProtectedSurfaceType {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let name = match *self {
            Self::UNPROTECTED => "UNPROTECTED",
            Self::HDCP_0 => "HDCP_0",
            Self::HDCP_1 => "HDCP_1",
            _ => return Debug::fmt(&self.0, f),
        };
        f.write_str(name)
    }
}