// 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::IsA;
use glib::translate::*;
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 `WebKitWebContext` to all [`WebExtension`][crate::WebExtension]<!-- -->s,
    /// from a [`WebExtension`][crate::WebExtension] to its corresponding `WebKitWebContext`, and from a `WebKitWebView` to its
    /// corresponding [`WebPage`][crate::WebPage] (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]
    #[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,
            ))
        }
    }

    /// Gets the quark for the domain of user message errors.
    ///
    /// # Returns
    ///
    /// user message error domain.
    #[doc(alias = "webkit_user_message_error_quark")]
    pub fn error_quark() -> glib::Quark {
        assert_initialized_main_thread!();
        unsafe { from_glib(ffi::webkit_user_message_error_quark()) }
    }
}

/// 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")
    }
}