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
use std::fmt::{self, Debug, Formatter};
use std::ops::Deref;

use super::AnonymousObject;
use wayland_commons::user_data::UserData;
use wayland_commons::Interface;

use wayland_sys::client::*;

use crate::event_queue::QueueToken;

use crate::imp::ProxyInner;

use wayland_commons::{filter::Filter, MessageGroup};

/// An handle to a wayland proxy
///
/// This represents a wayland object instantiated in your client
/// session. Several handles to the same object can exist at a given
/// time, and cloning them won't create a new protocol object, only
/// clone the handle. The lifetime of the protocol object is **not**
/// tied to the lifetime of these handles, but rather to sending or
/// receiving destroying messages.
///
/// These handles are notably used to send requests to the server. To do this
/// you need to convert them to the corresponding Rust object (using `.into()`)
/// and use methods on the Rust object.
///
/// This handle is the most conservative one: it can be sent between threads,
/// but you cannot send any message that would create a new object using it.
/// You must attach it to a event queue, that will host the newly created objects.
pub struct Proxy<I: Interface> {
    _i: ::std::marker::PhantomData<&'static I>,
    pub(crate) inner: ProxyInner,
}

impl<I: Interface> Clone for Proxy<I> {
    fn clone(&self) -> Proxy<I> {
        let mut cloned = self.inner.clone();
        // an owned Proxy must always be detached
        cloned.detach();
        Proxy { _i: ::std::marker::PhantomData, inner: cloned }
    }
}

impl<I: Interface> PartialEq for Proxy<I>
where
    I: AsRef<Proxy<I>> + From<Proxy<I>>,
{
    fn eq(&self, other: &Proxy<I>) -> bool {
        self.equals(other)
    }
}

impl<I: Interface> Debug for Proxy<I> {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "{}@{}", I::NAME, self.inner.id())
    }
}

impl<I: Interface> Eq for Proxy<I> where I: AsRef<Proxy<I>> + From<Proxy<I>> {}

impl<I: Interface> Proxy<I>
where
    I: AsRef<Proxy<I>> + From<Proxy<I>>,
{
    #[allow(dead_code)]
    pub(crate) fn wrap(inner: ProxyInner) -> Proxy<I> {
        Proxy { _i: ::std::marker::PhantomData, inner }
    }

    /// Send a request creating an object through this object
    ///
    /// **Warning:** This method is mostly intended to be used by code generated
    /// by `wayland-scanner`, and you should probably never need to use it directly,
    /// but rather use the appropriate methods on the Rust object.
    ///
    /// This is the generic method to send requests.
    pub fn send<J>(&self, msg: I::Request, version: Option<u32>) -> Option<Main<J>>
    where
        J: Interface + AsRef<Proxy<J>> + From<Proxy<J>>,
    {
        if msg.since() > self.version() && self.version() > 0 {
            let opcode = msg.opcode() as usize;
            panic!(
                "Cannot send request {} which requires version >= {} on proxy {}@{} which is version {}.",
                I::Request::MESSAGES[opcode].name,
                msg.since(),
                I::NAME,
                self.id(),
                self.version()
            );
        }
        self.inner.send::<I, J>(msg, version).map(Main::wrap)
    }

    /// Check if the object associated with this proxy is still alive
    ///
    /// Will return `false` if the object has been destroyed.
    ///
    /// If the object is not managed by this library (if it was created from a raw
    /// pointer from some other library your program interfaces with), this will always
    /// returns `true`.
    pub fn is_alive(&self) -> bool {
        self.inner.is_alive()
    }

    /// Retrieve the interface version of this wayland object instance
    ///
    /// Returns 0 on dead objects
    pub fn version(&self) -> u32 {
        self.inner.version()
    }

    /// Retrieve the object id of this wayland object
    pub fn id(&self) -> u32 {
        self.inner.id()
    }

    /// Access the UserData associated to this object
    ///
    /// Each wayland object has an associated UserData, that can store
    /// a payload of arbitrary type and is shared by all proxies of this
    /// object.
    ///
    /// See [`UserData`](struct.UserData.html) documentation for more details.
    pub fn user_data(&self) -> &UserData {
        self.inner.user_data()
    }

    /// Check if the other proxy refers to the same underlying wayland object
    ///
    /// You can also use the `PartialEq` implementation.
    pub fn equals(&self, other: &Proxy<I>) -> bool {
        self.inner.equals(&other.inner)
    }

    /// Attach this proxy to the event queue represented by this token
    ///
    /// Once a proxy is attached, you can use it to send requests that
    /// create new objects. These new objects will be handled by the
    /// event queue represented by the provided token.
    ///
    /// This does not impact the events received by this object, which
    /// are still handled by their original event queue.
    pub fn attach(&self, token: QueueToken) -> Attached<I> {
        let mut other = self.clone();
        other.inner.attach(&token.inner);
        Attached { inner: other.into(), _s: std::marker::PhantomData }
    }

    /// Erase the actual type of this proxy
    pub fn anonymize(self) -> Proxy<AnonymousObject> {
        Proxy { _i: ::std::marker::PhantomData, inner: self.inner }
    }
}

impl Proxy<AnonymousObject> {
    /// Attempt to recover the typed variant of an anonymous proxy
    pub fn deanonymize<I: Interface>(self) -> Result<Proxy<I>, Self> {
        if self.inner.is_interface::<I>() {
            Ok(Proxy { inner: self.inner, _i: ::std::marker::PhantomData })
        } else {
            Err(self)
        }
    }
}

impl<I: Interface + Debug> Debug for Attached<I> {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "{:?}[ATTACHED]", self.inner)
    }
}

/// A handle to a proxy that has been attached to an event queue
///
/// As opposed to `Proxy`, you can use it to send requests
/// that create new objects. The created objects will be handled
/// by the event queue this proxy has been attached to.
#[derive(PartialEq)]
pub struct Attached<I: Interface> {
    // AttachedProxy is *not* send/sync
    _s: ::std::marker::PhantomData<*mut ()>,
    inner: I,
}

impl<I: Interface> Attached<I>
where
    I: Into<Proxy<I>> + From<Proxy<I>> + AsRef<Proxy<I>>,
{
    /// Create a non-attached handle from this one
    pub fn detach(&self) -> I {
        self.inner.as_ref().clone().into()
    }
}

impl<I: Interface> Deref for Attached<I> {
    type Target = I;

    fn deref(&self) -> &I {
        &self.inner
    }
}

impl<I: Interface> Clone for Attached<I>
where
    I: AsRef<Proxy<I>> + From<Proxy<I>>,
{
    fn clone(&self) -> Attached<I> {
        let cloned = self.inner.as_ref().inner.clone();
        Attached {
            inner: Proxy { _i: std::marker::PhantomData, inner: cloned }.into(),
            _s: std::marker::PhantomData,
        }
    }
}

/// A main handle to a proxy
///
/// This handle allows the same control as an `Attached` handle,
/// but additionnaly can be used to assign the proxy to a `Filter`,
/// in order to process its events.
#[derive(Clone, PartialEq)]
pub struct Main<I: Interface + AsRef<Proxy<I>> + From<Proxy<I>>> {
    inner: Attached<I>,
}

impl<I: Interface> Main<I>
where
    I: AsRef<Proxy<I>> + From<Proxy<I>>,
{
    pub(crate) fn wrap(inner: ProxyInner) -> Main<I> {
        Main {
            inner: Attached {
                inner: Proxy { _i: std::marker::PhantomData, inner }.into(),
                _s: std::marker::PhantomData,
            },
        }
    }

    /// Assign this object to given filter
    ///
    /// All future event received by this object will be delivered to this
    /// filter.
    ///
    /// An object that is not assigned to any filter will see its events
    /// delivered to the fallback callback of its event queue.
    ///
    /// Event message type of the filter should verify
    /// `E: From<(Main<I>, I::Event)>`. See the `event_enum!` macro provided
    /// in this library to easily generate appropriate types.
    pub fn assign<E>(&self, filter: Filter<E>)
    where
        I: Sync,
        E: From<(Main<I>, I::Event)> + 'static,
        I::Event: MessageGroup<Map = crate::ProxyMap>,
    {
        self.inner.inner.as_ref().inner.assign(filter);
    }

    /// Shorthand for assigning a closure to an object
    ///
    /// Behaves similarly as `assign(..)`, but is a shorthand if
    /// you want to assign this object to its own filter. In which
    /// case you just need to provide the appropriate closure, of
    /// type `FnMut(Main<I>, I::Event)`.
    pub fn quick_assign<F>(&self, mut f: F)
    where
        I: Interface + AsRef<Proxy<I>> + From<Proxy<I>> + Sync,
        F: FnMut(Main<I>, I::Event, crate::DispatchData) + 'static,
        I::Event: MessageGroup<Map = crate::ProxyMap>,
    {
        self.assign(Filter::new(move |(proxy, event), _, data| f(proxy, event, data)))
    }
}

impl Main<AnonymousObject> {
    /// Attempt to recover the typed variant of an anonymous proxy
    pub fn deanonymize<I: Interface + AsRef<Proxy<I>> + From<Proxy<I>>>(
        self,
    ) -> Result<Main<I>, Self> {
        if self.inner.as_ref().inner.is_interface::<I>() {
            Ok(Main {
                inner: Attached {
                    inner: Proxy { _i: std::marker::PhantomData, inner: self.inner.inner.0.inner }
                        .into(),
                    _s: std::marker::PhantomData,
                },
            })
        } else {
            Err(self)
        }
    }
}

impl<I: Interface> Deref for Main<I>
where
    I: AsRef<Proxy<I>> + From<Proxy<I>>,
{
    type Target = Attached<I>;

    fn deref(&self) -> &Attached<I> {
        &self.inner
    }
}

impl<I: Interface> From<Main<I>> for Attached<I>
where
    I: AsRef<Proxy<I>> + From<Proxy<I>>,
{
    fn from(main: Main<I>) -> Attached<I> {
        main.inner
    }
}

impl<I: Interface> Debug for Main<I>
where
    I: Debug + AsRef<Proxy<I>> + From<Proxy<I>>,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "{:?}[MAIN]", self.inner.inner)
    }
}

/*
 * C-interfacing stuff
 */

impl<I: Interface> Main<I>
where
    I: AsRef<Proxy<I>> + From<Proxy<I>>,
{
    /// Create a `Main` instance from a C pointer
    ///
    /// Create a `Main` from a raw pointer to a wayland object from the
    /// C library.
    ///
    /// In order to handle protocol races, invoking it with a NULL pointer will
    /// create an already-dead object.
    ///
    /// NOTE: This method will panic if called while the `use_system_lib` feature is
    /// not activated.
    ///
    /// # Safety
    ///
    /// This will take control of the underlying proxy & manage it. To be safe
    /// you must ensure that:
    ///
    /// - The provided proxy has not already been used in any way (it was just created)
    /// - This is called from the same thread as the one hosting the event queue
    ///   handling this proxy
    pub unsafe fn from_c_ptr(_ptr: *mut wl_proxy) -> Main<I> {
        #[cfg(feature = "use_system_lib")]
        {
            Main::wrap(ProxyInner::init_from_c_ptr::<I>(_ptr))
        }
        #[cfg(not(feature = "use_system_lib"))]
        {
            panic!("[wayland-client] C interfacing methods can only be used with the `use_system_lib` cargo feature.")
        }
    }
}

impl<I: Interface + AsRef<Proxy<I>> + From<Proxy<I>>> Proxy<I> {
    /// Check whether this proxy is managed by the library or not
    ///
    /// See `from_c_ptr` for details.
    ///
    /// NOTE: This method will panic if called while the `use_system_lib` feature is
    /// not activated.
    pub fn is_external(&self) -> bool {
        #[cfg(feature = "use_system_lib")]
        {
            self.inner.is_external()
        }
        #[cfg(not(feature = "use_system_lib"))]
        {
            panic!("[wayland-client] C interfacing methods can only be used with the `use_system_lib` cargo feature.")
        }
    }

    /// Get a raw pointer to the underlying wayland object
    ///
    /// Retrieve a pointer to the object from the `libwayland-client.so` library.
    /// You will mostly need it to interface with C libraries needing access
    /// to wayland objects (to initialize an opengl context for example).
    ///
    /// NOTE: This method will panic if called while the `use_system_lib` feature is
    /// not activated.
    pub fn c_ptr(&self) -> *mut wl_proxy {
        #[cfg(feature = "use_system_lib")]
        {
            self.inner.c_ptr()
        }
        #[cfg(not(feature = "use_system_lib"))]
        {
            panic!("[wayland-client] C interfacing methods can only be used with the `use_system_lib` cargo feature.")
        }
    }

    /// Create a `Proxy` instance from a C pointer
    ///
    /// Create a `Proxy` from a raw pointer to a wayland object from the
    /// C library.
    ///
    /// If the pointer was previously obtained by the `c_ptr()` method, this
    /// constructs a new proxy for the same object just like the `clone()`
    /// method would have.
    ///
    /// If the object was created by some other C library you are interfacing
    /// with, it will be created in an "unmanaged" state: wayland-client will
    /// treat it as foreign, and as such most of the safeties will be absent.
    /// Notably the lifetime of the object can't be tracked, so the `alive()`
    /// method will always return `true` and you are responsible of not using
    /// an object past its destruction (as this would cause a protocol error).
    /// You will also be unable to associate any user data value to this object.
    ///
    /// In order to handle protocol races, invoking it with a NULL pointer will
    /// create an already-dead object.
    ///
    /// NOTE: This method will panic if called while the `use_system_lib` feature is
    /// not activated.
    ///
    /// # Safety
    ///
    /// The provided pointer must point to a valid wayland object from `libwayland-client`
    /// with the correct interface.
    pub unsafe fn from_c_ptr(_ptr: *mut wl_proxy) -> Proxy<I>
    where
        I: From<Proxy<I>>,
    {
        #[cfg(feature = "use_system_lib")]
        {
            Proxy { _i: ::std::marker::PhantomData, inner: ProxyInner::from_c_ptr::<I>(_ptr) }
        }
        #[cfg(not(feature = "use_system_lib"))]
        {
            panic!("[wayland-client] C interfacing methods can only be used with the `use_system_lib` cargo feature.")
        }
    }
}