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
use std::fmt::{self, Debug, Formatter};
use wayland_commons::user_data::UserData;
use wayland_commons::{Interface, MessageGroup};
use wayland_sys::server::*;
use crate::imp::ResourceInner;
use crate::{Client, Filter};
/// An handle to a wayland resource
///
/// This represents a wayland object instantiated in a 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 events to the associated client,
/// via the `send` method, although you're encouraged to use methods on the
/// corresponding Rust objects instead. To convert a `Resource<I>` into the
/// `I` Rust object, use the `.into()` method.
pub struct Resource<I: Interface> {
_i: ::std::marker::PhantomData<&'static I>,
inner: ResourceInner,
}
impl<I: Interface + From<Resource<I>> + AsRef<Resource<I>>> PartialEq for Resource<I> {
fn eq(&self, other: &Resource<I>) -> bool {
self.equals(other)
}
}
impl<I: Interface + From<Resource<I>> + AsRef<Resource<I>>> Eq for Resource<I> {}
impl<I> Resource<I>
where
I: Interface + From<Resource<I>> + AsRef<Resource<I>>,
{
#[allow(dead_code)]
pub(crate) fn wrap(inner: ResourceInner) -> Resource<I> {
Resource { _i: ::std::marker::PhantomData, inner }
}
/// Send an event through this object
///
/// The event will be send to the client associated to this object.
pub fn send(&self, msg: I::Event) {
#[cfg(feature = "use_system_lib")]
{
if !self.is_external() && !self.is_alive() {
return;
}
}
#[cfg(not(feature = "use_system_lib"))]
{
if !self.is_alive() {
return;
}
}
if msg.since() > self.version() {
let opcode = msg.opcode() as usize;
panic!(
"Cannot send event {} which requires version >= {} on resource {}@{} which is version {}.",
I::Event::MESSAGES[opcode].name,
msg.since(),
I::NAME,
self.id(),
self.version()
);
}
self.inner.send::<I>(msg)
}
/// Check if the object associated with this resource is still alive
///
/// Will return `false` if the object has been destroyed.
///
/// WHen using the `use_system_lib` feature, if this object was created
/// from a raw pointer the crate cannot track its lifetime, and this
/// method will always return `true`. You are responsible for only using
/// it while it is still alive.
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()
}
/// Check if the other resource refers to the same underlying wayland object
///
/// You can also use the `PartialEq` trait.
pub fn equals(&self, other: &Resource<I>) -> bool {
self.inner.equals(&other.inner)
}
/// Check if this resource and the other belong to the same client
///
/// Always return false if either of them is dead
pub fn same_client_as<II: Interface>(&self, other: &Resource<II>) -> bool {
self.inner.same_client_as(&other.inner)
}
/// Posts a protocol error to this resource
///
/// The error code can be obtained from the various `Error` enums of the protocols.
///
/// An error is fatal to the client that caused it.
pub fn post_error(&self, error_code: u32, msg: String) {
self.inner.post_error(error_code, msg)
}
/// 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 documentation for more details.
pub fn user_data(&self) -> &UserData {
self.inner.user_data()
}
/// Retrieve an handle to the client associated with this resource
///
/// Returns `None` if the resource is no longer alive.
pub fn client(&self) -> Option<Client> {
self.inner.client().map(Client::make)
}
/// Retrieve the object id of this wayland object
pub fn id(&self) -> u32 {
self.inner.id()
}
}
impl<I> Resource<I>
where
I: Interface + From<Resource<I>> + AsRef<Resource<I>>,
{
/// Check whether this resource 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-server] C interfacing methods are not available without the `use_system_lib` feature"
);
}
}
/// Get a raw pointer to the underlying wayland object
///
/// Retrieve a pointer to the object from the `libwayland-server.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_resource {
#[cfg(feature = "use_system_lib")]
{
self.inner.c_ptr()
}
#[cfg(not(feature = "use_system_lib"))]
{
panic!(
"[wayland-server] C interfacing methods are not available without the `use_system_lib` feature"
);
}
}
/// Create a `Resource` instance from a C pointer
///
/// Create a `Resource` 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 resource handle 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-server 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 `false` 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 pointer 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 be a valid pointer to a wayland object from
/// `libwayland-client` associated to the correct interface.
pub unsafe fn from_c_ptr(_ptr: *mut wl_resource) -> Self
where
I: From<Resource<I>>,
{
#[cfg(feature = "use_system_lib")]
{
Resource { _i: ::std::marker::PhantomData, inner: ResourceInner::from_c_ptr::<I>(_ptr) }
}
#[cfg(not(feature = "use_system_lib"))]
{
panic!(
"[wayland-server] C interfacing methods are not available without the `use_system_lib` feature"
);
}
}
#[doc(hidden)]
// This method is for scanner-generated use only
pub unsafe fn make_child_for<J: Interface + From<Resource<J>> + AsRef<Resource<J>>>(
&self,
_id: u32,
) -> Option<Main<J>> {
#[cfg(feature = "use_system_lib")]
{
self.inner.make_child_for::<J>(_id).map(Main::wrap)
}
#[cfg(not(feature = "use_system_lib"))]
{
panic!(
"[wayland-server] C interfacing methods are not available without the `use_system_lib` feature"
);
}
}
}
impl<I: Interface> Clone for Resource<I> {
fn clone(&self) -> Resource<I> {
Resource { _i: ::std::marker::PhantomData, inner: self.inner.clone() }
}
}
impl<I: Interface> Debug for Resource<I> {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "{}@{}", I::NAME, self.inner.id())
}
}
/// A main handle to a proxy
#[derive(Clone, PartialEq)]
pub struct Main<I: Interface + AsRef<Resource<I>> + From<Resource<I>>> {
inner: I,
_nonsend: std::marker::PhantomData<*mut ()>,
}
impl<I: Interface> Main<I>
where
I: AsRef<Resource<I>> + From<Resource<I>>,
{
pub(crate) fn wrap(inner: ResourceInner) -> Main<I> {
Main {
inner: Resource { _i: std::marker::PhantomData, inner }.into(),
_nonsend: std::marker::PhantomData,
}
}
/// Assign this object to given filter
///
/// All future requests received by this object will be delivered to this
/// filter.
///
/// An object that is not assigned to any filter will see trigger a protocol
/// error and kill its client signalling a server bug if it receives a request.
///
/// Message type of the filter should verify
/// `E: From<(Main<I>, I::Request)>`. See the `request_enum!` macro provided
/// in this library to easily generate appropriate types.
pub fn assign<E>(&self, filter: Filter<E>)
where
I: AsRef<Resource<I>> + From<Resource<I>>,
E: From<(Main<I>, I::Request)> + 'static,
I::Request: MessageGroup<Map = crate::ResourceMap>,
{
self.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<Resource<I>> + From<Resource<I>>,
F: FnMut(Main<I>, I::Request, crate::DispatchData) + 'static,
I::Request: MessageGroup<Map = crate::ResourceMap>,
{
self.assign(Filter::new(move |(proxy, event), _, data| f(proxy, event, data)))
}
/// Assign a destructor to this object
///
/// The filter will be called upon destruction of this object
/// with a payload of type `Resource<I>`.
pub fn assign_destructor<E>(&self, filter: Filter<E>)
where
I: AsRef<Resource<I>> + From<Resource<I>>,
E: From<Resource<I>> + 'static,
{
self.inner.as_ref().inner.assign_destructor(filter)
}
/// Create a `Main` instance from a C pointer to a new object
///
/// Create a `Main` from a raw pointer to a wayland object from the
/// C library by taking control of it.
///
/// 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 be a valid pointer to a wayland object from
/// `libwayland-client` associated to the correct interface.
///
/// You must ensure that this object was newly created and have never been user nor
/// had any listener associated.
pub unsafe fn init_from_c_ptr(_ptr: *mut wl_resource) -> Self {
#[cfg(feature = "use_system_lib")]
{
Main::wrap(ResourceInner::init_from_c_ptr::<I>(_ptr))
}
#[cfg(not(feature = "use_system_lib"))]
{
panic!(
"[wayland-server] C interfacing methods are not available without the `use_system_lib` feature"
);
}
}
}
impl<I> std::ops::Deref for Main<I>
where
I: Interface + AsRef<Resource<I>> + From<Resource<I>>,
{
type Target = I;
fn deref(&self) -> &I {
&self.inner
}
}
impl<I: Interface> Debug for Main<I>
where
I: Debug + AsRef<Resource<I>> + From<Resource<I>>,
{
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "{:?}[MAIN]", self.inner)
}
}