// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// from webkit2gtk-gir-files
// DO NOT EDIT

use glib::object::Cast;
use glib::object::IsA;
use glib::translate::*;
use glib::StaticType;
use glib::ToValue;
use std::fmt;

glib::wrapper! {
    /// Message that can be sent between the UI process and web extensions.
    ///
    /// A WebKitUserMessage is a message that can be used for the communication between the UI process
    /// and web extensions. A WebKitUserMessage always has a name, and it can also include parameters and
    /// UNIX file descriptors. Messages can be sent from a [`WebContext`][crate::WebContext] to all `WebKitWebExtension`<!-- -->s,
    /// from a `WebKitWebExtension` to its corresponding [`WebContext`][crate::WebContext], and from a [`WebView`][crate::WebView] to its
    /// corresponding `WebKitWebPage` (and vice versa). One to one messages can be replied to directly with
    /// [`UserMessageExt::send_reply()`][crate::prelude::UserMessageExt::send_reply()].
    ///
    /// # Implements
    ///
    /// [`UserMessageExt`][trait@crate::prelude::UserMessageExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "WebKitUserMessage")]
    pub struct UserMessage(Object<ffi::WebKitUserMessage, ffi::WebKitUserMessageClass>);

    match fn {
        type_ => || ffi::webkit_user_message_get_type(),
    }
}

impl UserMessage {
    pub const NONE: Option<&'static UserMessage> = None;

    /// Create a new [`UserMessage`][crate::UserMessage] with `name`.
    /// ## `name`
    /// the message name
    /// ## `parameters`
    /// the message parameters as a [`glib::Variant`][struct@crate::glib::Variant], or [`None`]
    ///
    /// # Returns
    ///
    /// the newly created [`UserMessage`][crate::UserMessage] object.
    #[doc(alias = "webkit_user_message_new")]
    pub fn new(name: &str, parameters: Option<&glib::Variant>) -> UserMessage {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_none(ffi::webkit_user_message_new(
                name.to_glib_none().0,
                parameters.to_glib_none().0,
            ))
        }
    }

    /// Create a new [`UserMessage`][crate::UserMessage] including also a list of UNIX file descriptors to be sent.
    /// ## `name`
    /// the message name
    /// ## `parameters`
    /// the message parameters as a [`glib::Variant`][struct@crate::glib::Variant]
    /// ## `fd_list`
    /// the message file descriptors
    ///
    /// # Returns
    ///
    /// the newly created [`UserMessage`][crate::UserMessage] object.
    #[doc(alias = "webkit_user_message_new_with_fd_list")]
    #[doc(alias = "new_with_fd_list")]
    pub fn with_fd_list(
        name: &str,
        parameters: Option<&glib::Variant>,
        fd_list: Option<&impl IsA<gio::UnixFDList>>,
    ) -> UserMessage {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_none(ffi::webkit_user_message_new_with_fd_list(
                name.to_glib_none().0,
                parameters.to_glib_none().0,
                fd_list.map(|p| p.as_ref()).to_glib_none().0,
            ))
        }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`UserMessage`] objects.
    ///
    /// This method returns an instance of [`UserMessageBuilder`](crate::builders::UserMessageBuilder) which can be used to create [`UserMessage`] objects.
    pub fn builder() -> UserMessageBuilder {
        UserMessageBuilder::default()
    }
}

#[cfg(any(feature = "v2_28", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v2_28")))]
impl Default for UserMessage {
    fn default() -> Self {
        glib::object::Object::new::<Self>(&[])
    }
}

#[derive(Clone, Default)]
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`UserMessage`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct UserMessageBuilder {
    #[cfg(any(feature = "v2_28", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v2_28")))]
    fd_list: Option<gio::UnixFDList>,
    #[cfg(any(feature = "v2_28", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v2_28")))]
    name: Option<String>,
    #[cfg(any(feature = "v2_28", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v2_28")))]
    parameters: Option<glib::Variant>,
}

impl UserMessageBuilder {
    // rustdoc-stripper-ignore-next
    /// Create a new [`UserMessageBuilder`].
    pub fn new() -> Self {
        Self::default()
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`UserMessage`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> UserMessage {
        let mut properties: Vec<(&str, &dyn ToValue)> = vec![];
        #[cfg(any(feature = "v2_28", feature = "dox"))]
        if let Some(ref fd_list) = self.fd_list {
            properties.push(("fd-list", fd_list));
        }
        #[cfg(any(feature = "v2_28", feature = "dox"))]
        if let Some(ref name) = self.name {
            properties.push(("name", name));
        }
        #[cfg(any(feature = "v2_28", feature = "dox"))]
        if let Some(ref parameters) = self.parameters {
            properties.push(("parameters", parameters));
        }
        glib::Object::new::<UserMessage>(&properties)
    }

    /// The UNIX file descriptors of the user message.
    #[cfg(any(feature = "v2_28", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v2_28")))]
    pub fn fd_list(mut self, fd_list: &impl IsA<gio::UnixFDList>) -> Self {
        self.fd_list = Some(fd_list.clone().upcast());
        self
    }

    /// The name of the user message.
    #[cfg(any(feature = "v2_28", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v2_28")))]
    pub fn name(mut self, name: &str) -> Self {
        self.name = Some(name.to_string());
        self
    }

    /// The parameters of the user message as a [`glib::Variant`][struct@crate::glib::Variant], or [`None`]
    /// if the message doesn't include parameters. Note that only complete types are
    /// allowed.
    #[cfg(any(feature = "v2_28", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v2_28")))]
    pub fn parameters(mut self, parameters: &glib::Variant) -> Self {
        self.parameters = Some(parameters.clone());
        self
    }
}

/// Trait containing all [`struct@UserMessage`] methods.
///
/// # Implementors
///
/// [`UserMessage`][struct@crate::UserMessage]
pub trait UserMessageExt: 'static {
    /// Get the `self` list of file descritpor.
    ///
    /// # Returns
    ///
    /// the message list of file descriptors
    #[doc(alias = "webkit_user_message_get_fd_list")]
    #[doc(alias = "get_fd_list")]
    fn fd_list(&self) -> Option<gio::UnixFDList>;

    /// Get the `self` name.
    ///
    /// # Returns
    ///
    /// the message name
    #[doc(alias = "webkit_user_message_get_name")]
    #[doc(alias = "get_name")]
    fn name(&self) -> Option<glib::GString>;

    /// Get the `self` parameters.
    ///
    /// # Returns
    ///
    /// the message parameters
    #[doc(alias = "webkit_user_message_get_parameters")]
    #[doc(alias = "get_parameters")]
    fn parameters(&self) -> Option<glib::Variant>;

    /// Send a reply to an user message.
    ///
    /// If `reply` is floating, it's consumed.
    /// You can only send a reply to a [`UserMessage`][crate::UserMessage] that has been
    /// received.
    /// ## `reply`
    /// a [`UserMessage`][crate::UserMessage] to send as reply
    #[doc(alias = "webkit_user_message_send_reply")]
    fn send_reply(&self, reply: &impl IsA<UserMessage>);
}

impl<O: IsA<UserMessage>> UserMessageExt for O {
    fn fd_list(&self) -> Option<gio::UnixFDList> {
        unsafe {
            from_glib_none(ffi::webkit_user_message_get_fd_list(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn name(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_user_message_get_name(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn parameters(&self) -> Option<glib::Variant> {
        unsafe {
            from_glib_none(ffi::webkit_user_message_get_parameters(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn send_reply(&self, reply: &impl IsA<UserMessage>) {
        unsafe {
            ffi::webkit_user_message_send_reply(
                self.as_ref().to_glib_none().0,
                reply.as_ref().to_glib_none().0,
            );
        }
    }
}

impl fmt::Display for UserMessage {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("UserMessage")
    }
}