wp_viewporter_client_protocol/

wp_viewporter_client_protocol.rs

// GENERATED FILE -- DO NOT EDIT
//
// Copyright © 2013-2016 Collabora, Ltd.
// 
// 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};
pub mod wp_viewporter {
use super::*;

/// surface cropping and scaling
///
/// The global interface exposing surface cropping and scaling
/// capabilities is used to instantiate an interface extension for a
/// wl_surface object. This extended interface will then allow
/// cropping and scaling the surface contents, effectively
/// disconnecting the direct relationship between the buffer and the
/// surface size.
#[derive(Debug)]
pub struct WpViewporter;

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

#[derive(Debug)]
pub enum Request {

    /// unbind from the cropping and scaling interface
    ///
    /// Informs the server that the client will not be using this
    /// protocol object anymore. This does not affect any other objects,
    /// wp_viewport objects included.
    Destroy,

    /// extend surface interface for crop and scale
    ///
    /// Instantiate an interface extension for the given wl_surface to
    /// crop and scale its content. If the given wl_surface already has
    /// a wp_viewport object associated, the viewport_exists
    /// protocol error is raised.
    GetViewport {
        /// the new viewport interface id
        id: NewId,
        /// the surface
        surface: ObjectId,
    },
}

impl MessageType for Request {
    fn log(&self, this: ObjectId) -> String {
        match *self {
            Request::Destroy {
            } => {
                format!("wp_viewporter@{:?}::destroy()", this)
            }
            Request::GetViewport {
                ref id,
                ref surface,
            } => {
                format!("wp_viewporter@{:?}::get_viewport(id: {:?}, surface: {:?})", this, id, surface)
            }
        }
    }
    fn message_name(&self) -> &'static std::ffi::CStr{
        match *self {
            Request::Destroy { .. } => c"wp_viewporter::destroy",
            Request::GetViewport { .. } => c"wp_viewporter::get_viewport",
        }
    }
}
#[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::GetViewport {
            id,
            surface,
        } => {
            msg.write_arg(Arg::NewId(id))?;
            msg.write_arg(Arg::Object(surface))?;
            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 {
        _ => {
            Err(DecodeError::InvalidOpcode(op).into())
        },
        }
    }
}
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[repr(u32)]
pub enum Error {
    /// the surface already has a viewport object associated,
    ViewportExists = 0,
}

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

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

pub use crate::wp_viewporter::WpViewporter;
pub use crate::wp_viewporter::Request as WpViewporterRequest;
pub use crate::wp_viewporter::Event as WpViewporterEvent;
pub mod wp_viewport {
use super::*;

/// crop and scale interface to a wl_surface
///
/// An additional interface to a wl_surface object, which allows the
/// client to specify the cropping and scaling of the surface
/// contents.
/// 
/// This interface works with two concepts: the source rectangle (src_x,
/// src_y, src_width, src_height), and the destination size (dst_width,
/// dst_height). The contents of the source rectangle are scaled to the
/// destination size, and content outside the source rectangle is ignored.
/// This state is double-buffered, and is applied on the next
/// wl_surface.commit.
/// 
/// The two parts of crop and scale state are independent: the source
/// rectangle, and the destination size. Initially both are unset, that
/// is, no scaling is applied. The whole of the current wl_buffer is
/// used as the source, and the surface size is as defined in
/// wl_surface.attach.
/// 
/// If the destination size is set, it causes the surface size to become
/// dst_width, dst_height. The source (rectangle) is scaled to exactly
/// this size. This overrides whatever the attached wl_buffer size is,
/// unless the wl_buffer is NULL. If the wl_buffer is NULL, the surface
/// has no content and therefore no size. Otherwise, the size is always
/// at least 1x1 in surface local coordinates.
/// 
/// If the source rectangle is set, it defines what area of the wl_buffer is
/// taken as the source. If the source rectangle is set and the destination
/// size is not set, then src_width and src_height must be integers, and the
/// surface size becomes the source rectangle size. This results in cropping
/// without scaling. If src_width or src_height are not integers and
/// destination size is not set, the bad_size protocol error is raised when
/// the surface state is applied.
/// 
/// The coordinate transformations from buffer pixel coordinates up to
/// the surface-local coordinates happen in the following order:
/// 1. buffer_transform (wl_surface.set_buffer_transform)
/// 2. buffer_scale (wl_surface.set_buffer_scale)
/// 3. crop and scale (wp_viewport.set*)
/// This means, that the source rectangle coordinates of crop and scale
/// are given in the coordinates after the buffer transform and scale,
/// i.e. in the coordinates that would be the surface-local coordinates
/// if the crop and scale was not applied.
/// 
/// If src_x or src_y are negative, the bad_value protocol error is raised.
/// Otherwise, if the source rectangle is partially or completely outside of
/// the non-NULL wl_buffer, then the out_of_buffer protocol error is raised
/// when the surface state is applied. A NULL wl_buffer does not raise the
/// out_of_buffer error.
/// 
/// The x, y arguments of wl_surface.attach are applied as normal to
/// the surface. They indicate how many pixels to remove from the
/// surface size from the left and the top. In other words, they are
/// still in the surface-local coordinate system, just like dst_width
/// and dst_height are.
/// 
/// If the wl_surface associated with the wp_viewport is destroyed,
/// all wp_viewport requests except 'destroy' raise the protocol error
/// no_surface.
/// 
/// If the wp_viewport object is destroyed, the crop and scale
/// state is removed from the wl_surface. The change will be applied
/// on the next wl_surface.commit.
#[derive(Debug)]
pub struct WpViewport;

impl Interface for WpViewport {
    const NAME: &'static str = "wp_viewport";
    const VERSION: u32 = 1;
    const REQUESTS: MessageGroupSpec = MessageGroupSpec(&[
        // destroy
        MessageSpec(&[
        ]),
        // set_source
        MessageSpec(&[
            ArgKind::Fixed,
            ArgKind::Fixed,
            ArgKind::Fixed,
            ArgKind::Fixed,
        ]),
        // set_destination
        MessageSpec(&[
            ArgKind::Int,
            ArgKind::Int,
        ]),
    ]);
    const EVENTS: MessageGroupSpec = MessageGroupSpec(&[
    ]);
    type Incoming = Event;
    type Outgoing = Request;
}

#[derive(Debug)]
pub enum Request {

    /// remove scaling and cropping from the surface
    ///
    /// The associated wl_surface's crop and scale state is removed.
    /// The change is applied on the next wl_surface.commit.
    Destroy,

    /// set the source rectangle for cropping
    ///
    /// Set the source rectangle of the associated wl_surface. See
    /// wp_viewport for the description, and relation to the wl_buffer
    /// size.
    /// 
    /// If all of x, y, width and height are -1.0, the source rectangle is
    /// unset instead. Any other set of values where width or height are zero
    /// or negative, or x or y are negative, raise the bad_value protocol
    /// error.
    /// 
    /// The crop and scale state is double-buffered state, and will be
    /// applied on the next wl_surface.commit.
    SetSource {
        /// source rectangle x
        x: Fixed,
        /// source rectangle y
        y: Fixed,
        /// source rectangle width
        width: Fixed,
        /// source rectangle height
        height: Fixed,
    },

    /// set the surface size for scaling
    ///
    /// Set the destination size of the associated wl_surface. See
    /// wp_viewport for the description, and relation to the wl_buffer
    /// size.
    /// 
    /// If width is -1 and height is -1, the destination size is unset
    /// instead. Any other pair of values for width and height that
    /// contains zero or negative values raises the bad_value protocol
    /// error.
    /// 
    /// The crop and scale state is double-buffered state, and will be
    /// applied on the next wl_surface.commit.
    SetDestination {
        /// surface width
        width: i32,
        /// surface height
        height: i32,
    },
}

impl MessageType for Request {
    fn log(&self, this: ObjectId) -> String {
        match *self {
            Request::Destroy {
            } => {
                format!("wp_viewport@{:?}::destroy()", this)
            }
            Request::SetSource {
                ref x,
                ref y,
                ref width,
                ref height,
            } => {
                format!("wp_viewport@{:?}::set_source(x: {:?}, y: {:?}, width: {:?}, height: {:?})", this, x, y, width, height)
            }
            Request::SetDestination {
                ref width,
                ref height,
            } => {
                format!("wp_viewport@{:?}::set_destination(width: {:?}, height: {:?})", this, width, height)
            }
        }
    }
    fn message_name(&self) -> &'static std::ffi::CStr{
        match *self {
            Request::Destroy { .. } => c"wp_viewport::destroy",
            Request::SetSource { .. } => c"wp_viewport::set_source",
            Request::SetDestination { .. } => c"wp_viewport::set_destination",
        }
    }
}
#[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::SetSource {
            x,
            y,
            width,
            height,
        } => {
            msg.write_arg(Arg::Fixed(x))?;
            msg.write_arg(Arg::Fixed(y))?;
            msg.write_arg(Arg::Fixed(width))?;
            msg.write_arg(Arg::Fixed(height))?;
            header.opcode = 1;
        },
        Request::SetDestination {
            width,
            height,
        } => {
            msg.write_arg(Arg::Int(width))?;
            msg.write_arg(Arg::Int(height))?;
            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())
        },
        }
    }
}
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[repr(u32)]
pub enum Error {
    /// negative or zero values in width or height,
    BadValue = 0,
    /// destination size is not integer,
    BadSize = 1,
    /// source rectangle extends outside of the content area,
    OutOfBuffer = 2,
    /// the wl_surface was destroyed,
    NoSurface = 3,
}

impl Error {
    pub fn from_bits(v: u32) -> Option<Self> {
        match v {
        0 => Some(Error::BadValue),
        1 => Some(Error::BadSize),
        2 => Some(Error::OutOfBuffer),
        3 => Some(Error::NoSurface),
        _ => None,
        }
    }

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

pub use crate::wp_viewport::WpViewport;
pub use crate::wp_viewport::Request as WpViewportRequest;
pub use crate::wp_viewport::Event as WpViewportEvent;