zwp_pointer_constraints_v1_client_protocol/

zwp_pointer_constraints_v1_client_protocol.rs

// GENERATED FILE -- DO NOT EDIT
//
// Copyright © 2014      Jonas Ådahl
// Copyright © 2015      Red Hat Inc.
// 
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice (including the next
// paragraph) shall be included in all copies or substantial portions of the
// Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

#![allow(warnings)]
#![allow(clippy::all)]
use anyhow;
#[allow(unused_imports)]
use fuchsia_wayland_core::{Array, Enum, Fixed, NewId, NewObject};
use fuchsia_wayland_core::{ArgKind, Arg, FromArgs, IntoMessage, Message,
                            MessageGroupSpec, MessageHeader, MessageSpec, MessageType,
                            ObjectId, EncodeError, DecodeError, Interface};

#[allow(unused_imports)]
use wayland_client_protocol::*;
pub mod zwp_pointer_constraints_v1 {
use super::*;

/// constrain the movement of a pointer
///
/// The global interface exposing pointer constraining functionality. It
/// exposes two requests: lock_pointer for locking the pointer to its
/// position, and confine_pointer for locking the pointer to a region.
/// 
/// The lock_pointer and confine_pointer requests create the objects
/// wp_locked_pointer and wp_confined_pointer respectively, and the client can
/// use these objects to interact with the lock.
/// 
/// For any surface, only one lock or confinement may be active across all
/// wl_pointer objects of the same seat. If a lock or confinement is requested
/// when another lock or confinement is active or requested on the same surface
/// and with any of the wl_pointer objects of the same seat, an
/// 'already_constrained' error will be raised.
#[derive(Debug)]
pub struct ZwpPointerConstraintsV1;

impl Interface for ZwpPointerConstraintsV1 {
    const NAME: &'static str = "zwp_pointer_constraints_v1";
    const VERSION: u32 = 1;
    const REQUESTS: MessageGroupSpec = MessageGroupSpec(&[
        // destroy
        MessageSpec(&[
        ]),
        // lock_pointer
        MessageSpec(&[
            ArgKind::NewId,
            ArgKind::Object,
            ArgKind::Object,
            ArgKind::Object,
            ArgKind::Uint,
        ]),
        // confine_pointer
        MessageSpec(&[
            ArgKind::NewId,
            ArgKind::Object,
            ArgKind::Object,
            ArgKind::Object,
            ArgKind::Uint,
        ]),
    ]);
    const EVENTS: MessageGroupSpec = MessageGroupSpec(&[
    ]);
    type Incoming = Event;
    type Outgoing = Request;
}

#[derive(Debug)]
pub enum Request {

    /// destroy the pointer constraints manager object
    ///
    /// Used by the client to notify the server that it will no longer use this
    /// pointer constraints object.
    Destroy,

    /// lock pointer to a position
    ///
    /// The lock_pointer request lets the client request to disable movements of
    /// the virtual pointer (i.e. the cursor), effectively locking the pointer
    /// to a position. This request may not take effect immediately; in the
    /// future, when the compositor deems implementation-specific constraints
    /// are satisfied, the pointer lock will be activated and the compositor
    /// sends a locked event.
    /// 
    /// The protocol provides no guarantee that the constraints are ever
    /// satisfied, and does not require the compositor to send an error if the
    /// constraints cannot ever be satisfied. It is thus possible to request a
    /// lock that will never activate.
    /// 
    /// There may not be another pointer constraint of any kind requested or
    /// active on the surface for any of the wl_pointer objects of the seat of
    /// the passed pointer when requesting a lock. If there is, an error will be
    /// raised. See general pointer lock documentation for more details.
    /// 
    /// The intersection of the region passed with this request and the input
    /// region of the surface is used to determine where the pointer must be
    /// in order for the lock to activate. It is up to the compositor whether to
    /// warp the pointer or require some kind of user interaction for the lock
    /// to activate. If the region is null the surface input region is used.
    /// 
    /// A surface may receive pointer focus without the lock being activated.
    /// 
    /// The request creates a new object wp_locked_pointer which is used to
    /// interact with the lock as well as receive updates about its state. See
    /// the the description of wp_locked_pointer for further information.
    /// 
    /// Note that while a pointer is locked, the wl_pointer objects of the
    /// corresponding seat will not emit any wl_pointer.motion events, but
    /// relative motion events will still be emitted via wp_relative_pointer
    /// objects of the same seat. wl_pointer.axis and wl_pointer.button events
    /// are unaffected.
    LockPointer {
        id: NewId,
        /// surface to lock pointer to
        surface: ObjectId,
        /// the pointer that should be locked
        pointer: ObjectId,
        /// region of surface
        region: ObjectId,
        /// lock lifetime
        lifetime: Lifetime,
    },

    /// confine pointer to a region
    ///
    /// The confine_pointer request lets the client request to confine the
    /// pointer cursor to a given region. This request may not take effect
    /// immediately; in the future, when the compositor deems implementation-
    /// specific constraints are satisfied, the pointer confinement will be
    /// activated and the compositor sends a confined event.
    /// 
    /// The intersection of the region passed with this request and the input
    /// region of the surface is used to determine where the pointer must be
    /// in order for the confinement to activate. It is up to the compositor
    /// whether to warp the pointer or require some kind of user interaction for
    /// the confinement to activate. If the region is null the surface input
    /// region is used.
    /// 
    /// The request will create a new object wp_confined_pointer which is used
    /// to interact with the confinement as well as receive updates about its
    /// state. See the the description of wp_confined_pointer for further
    /// information.
    ConfinePointer {
        id: NewId,
        /// surface to lock pointer to
        surface: ObjectId,
        /// the pointer that should be confined
        pointer: ObjectId,
        /// region of surface
        region: ObjectId,
        /// confinement lifetime
        lifetime: Lifetime,
    },
}

impl MessageType for Request {
    fn log(&self, this: ObjectId) -> String {
        match *self {
            Request::Destroy {
            } => {
                format!("zwp_pointer_constraints_v1@{:?}::destroy()", this)
            }
            Request::LockPointer {
                ref id,
                ref surface,
                ref pointer,
                ref region,
                ref lifetime,
            } => {
                format!("zwp_pointer_constraints_v1@{:?}::lock_pointer(id: {:?}, surface: {:?}, pointer: {:?}, region: {:?}, lifetime: {:?})", this, id, surface, pointer, region, lifetime)
            }
            Request::ConfinePointer {
                ref id,
                ref surface,
                ref pointer,
                ref region,
                ref lifetime,
            } => {
                format!("zwp_pointer_constraints_v1@{:?}::confine_pointer(id: {:?}, surface: {:?}, pointer: {:?}, region: {:?}, lifetime: {:?})", this, id, surface, pointer, region, lifetime)
            }
        }
    }
    fn message_name(&self) -> &'static std::ffi::CStr{
        match *self {
            Request::Destroy { .. } => c"zwp_pointer_constraints_v1::destroy",
            Request::LockPointer { .. } => c"zwp_pointer_constraints_v1::lock_pointer",
            Request::ConfinePointer { .. } => c"zwp_pointer_constraints_v1::confine_pointer",
        }
    }
}
#[derive(Debug)]
pub enum Event {
}

impl MessageType for Event {
    fn log(&self, this: ObjectId) -> String {
        match *self {
        }
    }
    fn message_name(&self) -> &'static std::ffi::CStr{
        match *self {
        }
    }
}
impl IntoMessage for Request {
    type Error = EncodeError;
    fn into_message(self, id: u32) -> Result<Message, <Self as IntoMessage>::Error> {
        let mut header = MessageHeader {
            sender: id,
            opcode: 0,
            length: 0,
        };
        let mut msg = Message::new();
        msg.write_header(&header)?;
        match self {
        Request::Destroy {
        } => {
            header.opcode = 0;
        },
        Request::LockPointer {
            id,
            surface,
            pointer,
            region,
            lifetime,
        } => {
            msg.write_arg(Arg::NewId(id))?;
            msg.write_arg(Arg::Object(surface))?;
            msg.write_arg(Arg::Object(pointer))?;
            msg.write_arg(Arg::Object(region))?;
            msg.write_arg(Arg::Uint(lifetime.bits()))?;
            header.opcode = 1;
        },
        Request::ConfinePointer {
            id,
            surface,
            pointer,
            region,
            lifetime,
        } => {
            msg.write_arg(Arg::NewId(id))?;
            msg.write_arg(Arg::Object(surface))?;
            msg.write_arg(Arg::Object(pointer))?;
            msg.write_arg(Arg::Object(region))?;
            msg.write_arg(Arg::Uint(lifetime.bits()))?;
            header.opcode = 2;
        },
        }
        header.length = msg.bytes().len() as u16;
        msg.rewind();
        msg.write_header(&header)?;
        Ok(msg)
    }
}
impl FromArgs for Event {
    fn from_args(op: u16, mut args: Vec<Arg>) -> Result<Self, anyhow::Error> {
        match op {
        _ => {
            Err(DecodeError::InvalidOpcode(op).into())
        },
        }
    }
}

/// wp_pointer_constraints error values
///
/// These errors can be emitted in response to wp_pointer_constraints
/// requests.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[repr(u32)]
pub enum Error {
    /// pointer constraint already requested on that surface,
    AlreadyConstrained = 1,
}

impl Error {
    pub fn from_bits(v: u32) -> Option<Self> {
        match v {
        1 => Some(Error::AlreadyConstrained),
        _ => None,
        }
    }

    pub fn bits(&self) -> u32 {
        *self as u32
    }
}
impl Into<Arg> for Error {
    fn into(self) -> Arg {
        Arg::Uint(self.bits())
    }
}

/// constraint lifetime
///
/// These values represent different lifetime semantics. They are passed
/// as arguments to the factory requests to specify how the constraint
/// lifetimes should be managed.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[repr(u32)]
pub enum Lifetime {
    Oneshot = 1,
    Persistent = 2,
}

impl Lifetime {
    pub fn from_bits(v: u32) -> Option<Self> {
        match v {
        1 => Some(Lifetime::Oneshot),
        2 => Some(Lifetime::Persistent),
        _ => None,
        }
    }

    pub fn bits(&self) -> u32 {
        *self as u32
    }
}
impl Into<Arg> for Lifetime {
    fn into(self) -> Arg {
        Arg::Uint(self.bits())
    }
}
} // mod zwp_pointer_constraints_v1

pub use crate::zwp_pointer_constraints_v1::ZwpPointerConstraintsV1;
pub use crate::zwp_pointer_constraints_v1::Request as ZwpPointerConstraintsV1Request;
pub use crate::zwp_pointer_constraints_v1::Event as ZwpPointerConstraintsV1Event;
pub mod zwp_locked_pointer_v1 {
use super::*;

/// receive relative pointer motion events
///
/// The wp_locked_pointer interface represents a locked pointer state.
/// 
/// While the lock of this object is active, the wl_pointer objects of the
/// associated seat will not emit any wl_pointer.motion events.
/// 
/// This object will send the event 'locked' when the lock is activated.
/// Whenever the lock is activated, it is guaranteed that the locked surface
/// will already have received pointer focus and that the pointer will be
/// within the region passed to the request creating this object.
/// 
/// To unlock the pointer, send the destroy request. This will also destroy
/// the wp_locked_pointer object.
/// 
/// If the compositor decides to unlock the pointer the unlocked event is
/// sent. See wp_locked_pointer.unlock for details.
/// 
/// When unlocking, the compositor may warp the cursor position to the set
/// cursor position hint. If it does, it will not result in any relative
/// motion events emitted via wp_relative_pointer.
/// 
/// If the surface the lock was requested on is destroyed and the lock is not
/// yet activated, the wp_locked_pointer object is now defunct and must be
/// destroyed.
#[derive(Debug)]
pub struct ZwpLockedPointerV1;

impl Interface for ZwpLockedPointerV1 {
    const NAME: &'static str = "zwp_locked_pointer_v1";
    const VERSION: u32 = 1;
    const REQUESTS: MessageGroupSpec = MessageGroupSpec(&[
        // destroy
        MessageSpec(&[
        ]),
        // set_cursor_position_hint
        MessageSpec(&[
            ArgKind::Fixed,
            ArgKind::Fixed,
        ]),
        // set_region
        MessageSpec(&[
            ArgKind::Object,
        ]),
    ]);
    const EVENTS: MessageGroupSpec = MessageGroupSpec(&[
        // locked
        MessageSpec(&[
        ]),
        // unlocked
        MessageSpec(&[
        ]),
    ]);
    type Incoming = Event;
    type Outgoing = Request;
}

#[derive(Debug)]
pub enum Request {

    /// destroy the locked pointer object
    ///
    /// Destroy the locked pointer object. If applicable, the compositor will
    /// unlock the pointer.
    Destroy,

    /// set the pointer cursor position hint
    ///
    /// Set the cursor position hint relative to the top left corner of the
    /// surface.
    /// 
    /// If the client is drawing its own cursor, it should update the position
    /// hint to the position of its own cursor. A compositor may use this
    /// information to warp the pointer upon unlock in order to avoid pointer
    /// jumps.
    /// 
    /// The cursor position hint is double buffered. The new hint will only take
    /// effect when the associated surface gets it pending state applied. See
    /// wl_surface.commit for details.
    SetCursorPositionHint {
        /// surface-local x coordinate
        surface_x: Fixed,
        /// surface-local y coordinate
        surface_y: Fixed,
    },

    /// set a new lock region
    ///
    /// Set a new region used to lock the pointer.
    /// 
    /// The new lock region is double-buffered. The new lock region will
    /// only take effect when the associated surface gets its pending state
    /// applied. See wl_surface.commit for details.
    /// 
    /// For details about the lock region, see wp_locked_pointer.
    SetRegion {
        /// region of surface
        region: ObjectId,
    },
}

impl MessageType for Request {
    fn log(&self, this: ObjectId) -> String {
        match *self {
            Request::Destroy {
            } => {
                format!("zwp_locked_pointer_v1@{:?}::destroy()", this)
            }
            Request::SetCursorPositionHint {
                ref surface_x,
                ref surface_y,
            } => {
                format!("zwp_locked_pointer_v1@{:?}::set_cursor_position_hint(surface_x: {:?}, surface_y: {:?})", this, surface_x, surface_y)
            }
            Request::SetRegion {
                ref region,
            } => {
                format!("zwp_locked_pointer_v1@{:?}::set_region(region: {:?})", this, region)
            }
        }
    }
    fn message_name(&self) -> &'static std::ffi::CStr{
        match *self {
            Request::Destroy { .. } => c"zwp_locked_pointer_v1::destroy",
            Request::SetCursorPositionHint { .. } => c"zwp_locked_pointer_v1::set_cursor_position_hint",
            Request::SetRegion { .. } => c"zwp_locked_pointer_v1::set_region",
        }
    }
}
#[derive(Debug)]
pub enum Event {

    /// lock activation event
    ///
    /// Notification that the pointer lock of the seat's pointer is activated.
    Locked,

    /// lock deactivation event
    ///
    /// Notification that the pointer lock of the seat's pointer is no longer
    /// active. If this is a oneshot pointer lock (see
    /// wp_pointer_constraints.lifetime) this object is now defunct and should
    /// be destroyed. If this is a persistent pointer lock (see
    /// wp_pointer_constraints.lifetime) this pointer lock may again
    /// reactivate in the future.
    Unlocked,
}

impl MessageType for Event {
    fn log(&self, this: ObjectId) -> String {
        match *self {
            Event::Locked {
            } => {
                format!("zwp_locked_pointer_v1@{:?}::locked()", this)
            }
            Event::Unlocked {
            } => {
                format!("zwp_locked_pointer_v1@{:?}::unlocked()", this)
            }
        }
    }
    fn message_name(&self) -> &'static std::ffi::CStr{
        match *self {
            Event::Locked { .. } => c"zwp_locked_pointer_v1::locked",
            Event::Unlocked { .. } => c"zwp_locked_pointer_v1::unlocked",
        }
    }
}
impl IntoMessage for Request {
    type Error = EncodeError;
    fn into_message(self, id: u32) -> Result<Message, <Self as IntoMessage>::Error> {
        let mut header = MessageHeader {
            sender: id,
            opcode: 0,
            length: 0,
        };
        let mut msg = Message::new();
        msg.write_header(&header)?;
        match self {
        Request::Destroy {
        } => {
            header.opcode = 0;
        },
        Request::SetCursorPositionHint {
            surface_x,
            surface_y,
        } => {
            msg.write_arg(Arg::Fixed(surface_x))?;
            msg.write_arg(Arg::Fixed(surface_y))?;
            header.opcode = 1;
        },
        Request::SetRegion {
            region,
        } => {
            msg.write_arg(Arg::Object(region))?;
            header.opcode = 2;
        },
        }
        header.length = msg.bytes().len() as u16;
        msg.rewind();
        msg.write_header(&header)?;
        Ok(msg)
    }
}
impl FromArgs for Event {
    fn from_args(op: u16, mut args: Vec<Arg>) -> Result<Self, anyhow::Error> {
        match op {
        0 /* locked */ => {
            let mut iter = args.into_iter();
            Ok(Event::Locked {

            })
        },
        1 /* unlocked */ => {
            let mut iter = args.into_iter();
            Ok(Event::Unlocked {

            })
        },
        _ => {
            Err(DecodeError::InvalidOpcode(op).into())
        },
        }
    }
}
} // mod zwp_locked_pointer_v1

pub use crate::zwp_locked_pointer_v1::ZwpLockedPointerV1;
pub use crate::zwp_locked_pointer_v1::Request as ZwpLockedPointerV1Request;
pub use crate::zwp_locked_pointer_v1::Event as ZwpLockedPointerV1Event;
pub mod zwp_confined_pointer_v1 {
use super::*;

/// confined pointer object
///
/// The wp_confined_pointer interface represents a confined pointer state.
/// 
/// This object will send the event 'confined' when the confinement is
/// activated. Whenever the confinement is activated, it is guaranteed that
/// the surface the pointer is confined to will already have received pointer
/// focus and that the pointer will be within the region passed to the request
/// creating this object. It is up to the compositor to decide whether this
/// requires some user interaction and if the pointer will warp to within the
/// passed region if outside.
/// 
/// To unconfine the pointer, send the destroy request. This will also destroy
/// the wp_confined_pointer object.
/// 
/// If the compositor decides to unconfine the pointer the unconfined event is
/// sent. The wp_confined_pointer object is at this point defunct and should
/// be destroyed.
#[derive(Debug)]
pub struct ZwpConfinedPointerV1;

impl Interface for ZwpConfinedPointerV1 {
    const NAME: &'static str = "zwp_confined_pointer_v1";
    const VERSION: u32 = 1;
    const REQUESTS: MessageGroupSpec = MessageGroupSpec(&[
        // destroy
        MessageSpec(&[
        ]),
        // set_region
        MessageSpec(&[
            ArgKind::Object,
        ]),
    ]);
    const EVENTS: MessageGroupSpec = MessageGroupSpec(&[
        // confined
        MessageSpec(&[
        ]),
        // unconfined
        MessageSpec(&[
        ]),
    ]);
    type Incoming = Event;
    type Outgoing = Request;
}

#[derive(Debug)]
pub enum Request {

    /// destroy the confined pointer object
    ///
    /// Destroy the confined pointer object. If applicable, the compositor will
    /// unconfine the pointer.
    Destroy,

    /// set a new confine region
    ///
    /// Set a new region used to confine the pointer.
    /// 
    /// The new confine region is double-buffered. The new confine region will
    /// only take effect when the associated surface gets its pending state
    /// applied. See wl_surface.commit for details.
    /// 
    /// If the confinement is active when the new confinement region is applied
    /// and the pointer ends up outside of newly applied region, the pointer may
    /// warped to a position within the new confinement region. If warped, a
    /// wl_pointer.motion event will be emitted, but no
    /// wp_relative_pointer.relative_motion event.
    /// 
    /// The compositor may also, instead of using the new region, unconfine the
    /// pointer.
    /// 
    /// For details about the confine region, see wp_confined_pointer.
    SetRegion {
        /// region of surface
        region: ObjectId,
    },
}

impl MessageType for Request {
    fn log(&self, this: ObjectId) -> String {
        match *self {
            Request::Destroy {
            } => {
                format!("zwp_confined_pointer_v1@{:?}::destroy()", this)
            }
            Request::SetRegion {
                ref region,
            } => {
                format!("zwp_confined_pointer_v1@{:?}::set_region(region: {:?})", this, region)
            }
        }
    }
    fn message_name(&self) -> &'static std::ffi::CStr{
        match *self {
            Request::Destroy { .. } => c"zwp_confined_pointer_v1::destroy",
            Request::SetRegion { .. } => c"zwp_confined_pointer_v1::set_region",
        }
    }
}
#[derive(Debug)]
pub enum Event {

    /// pointer confined
    ///
    /// Notification that the pointer confinement of the seat's pointer is
    /// activated.
    Confined,

    /// pointer unconfined
    ///
    /// Notification that the pointer confinement of the seat's pointer is no
    /// longer active. If this is a oneshot pointer confinement (see
    /// wp_pointer_constraints.lifetime) this object is now defunct and should
    /// be destroyed. If this is a persistent pointer confinement (see
    /// wp_pointer_constraints.lifetime) this pointer confinement may again
    /// reactivate in the future.
    Unconfined,
}

impl MessageType for Event {
    fn log(&self, this: ObjectId) -> String {
        match *self {
            Event::Confined {
            } => {
                format!("zwp_confined_pointer_v1@{:?}::confined()", this)
            }
            Event::Unconfined {
            } => {
                format!("zwp_confined_pointer_v1@{:?}::unconfined()", this)
            }
        }
    }
    fn message_name(&self) -> &'static std::ffi::CStr{
        match *self {
            Event::Confined { .. } => c"zwp_confined_pointer_v1::confined",
            Event::Unconfined { .. } => c"zwp_confined_pointer_v1::unconfined",
        }
    }
}
impl IntoMessage for Request {
    type Error = EncodeError;
    fn into_message(self, id: u32) -> Result<Message, <Self as IntoMessage>::Error> {
        let mut header = MessageHeader {
            sender: id,
            opcode: 0,
            length: 0,
        };
        let mut msg = Message::new();
        msg.write_header(&header)?;
        match self {
        Request::Destroy {
        } => {
            header.opcode = 0;
        },
        Request::SetRegion {
            region,
        } => {
            msg.write_arg(Arg::Object(region))?;
            header.opcode = 1;
        },
        }
        header.length = msg.bytes().len() as u16;
        msg.rewind();
        msg.write_header(&header)?;
        Ok(msg)
    }
}
impl FromArgs for Event {
    fn from_args(op: u16, mut args: Vec<Arg>) -> Result<Self, anyhow::Error> {
        match op {
        0 /* confined */ => {
            let mut iter = args.into_iter();
            Ok(Event::Confined {

            })
        },
        1 /* unconfined */ => {
            let mut iter = args.into_iter();
            Ok(Event::Unconfined {

            })
        },
        _ => {
            Err(DecodeError::InvalidOpcode(op).into())
        },
        }
    }
}
} // mod zwp_confined_pointer_v1

pub use crate::zwp_confined_pointer_v1::ZwpConfinedPointerV1;
pub use crate::zwp_confined_pointer_v1::Request as ZwpConfinedPointerV1Request;
pub use crate::zwp_confined_pointer_v1::Event as ZwpConfinedPointerV1Event;