//
// DO NOT EDIT.  THIS FILE IS GENERATED FROM ../../../dist/idl/nsILoginManagerPrompter.idl
//


/// `interface nsILoginManagerPrompter : nsISupports`
///


// The actual type definition for the interface. This struct has methods
// declared on it which will call through its vtable. You never want to pass
// this type around by value, always pass it behind a reference.

#[repr(C)]
pub struct nsILoginManagerPrompter {
    vtable: *const nsILoginManagerPrompterVTable,

    /// This field is a phantomdata to ensure that the VTable type and any
    /// struct containing it is not safe to send across threads, as XPCOM is
    /// generally not threadsafe.
    ///
    /// XPCOM interfaces in general are not safe to send across threads.
    __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>,
}

// Implementing XpCom for an interface exposes its IID, which allows for easy
// use of the `.query_interface<T>` helper method. This also defines that
// method for nsILoginManagerPrompter.
unsafe impl XpCom for nsILoginManagerPrompter {
    const IID: nsIID = nsID(0x425f73b9, 0xb2db, 0x4e8a,
        [0x88, 0xc5, 0x9a, 0xc2, 0x51, 0x29, 0x34, 0xce]);
}

// We need to implement the RefCounted trait so we can be used with `RefPtr`.
// This trait teaches `RefPtr` how to manage our memory.
unsafe impl RefCounted for nsILoginManagerPrompter {
    #[inline]
    unsafe fn addref(&self) {
        self.AddRef();
    }
    #[inline]
    unsafe fn release(&self) {
        self.Release();
    }
}

// This trait is implemented on all types which can be coerced to from nsILoginManagerPrompter.
// It is used in the implementation of `fn coerce<T>`. We hide it from the
// documentation, because it clutters it up a lot.
#[doc(hidden)]
pub trait nsILoginManagerPrompterCoerce {
    /// Cheaply cast a value of this type from a `nsILoginManagerPrompter`.
    fn coerce_from(v: &nsILoginManagerPrompter) -> &Self;
}

// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsILoginManagerPrompterCoerce for nsILoginManagerPrompter {
    #[inline]
    fn coerce_from(v: &nsILoginManagerPrompter) -> &Self {
        v
    }
}

impl nsILoginManagerPrompter {
    /// Cast this `nsILoginManagerPrompter` to one of its base interfaces.
    #[inline]
    pub fn coerce<T: nsILoginManagerPrompterCoerce>(&self) -> &T {
        T::coerce_from(self)
    }
}

// Every interface struct type implements `Deref` to its base interface. This
// causes methods on the base interfaces to be directly avaliable on the
// object. For example, you can call `.AddRef` or `.QueryInterface` directly
// on any interface which inherits from `nsISupports`.
impl ::std::ops::Deref for nsILoginManagerPrompter {
    type Target = nsISupports;
    #[inline]
    fn deref(&self) -> &nsISupports {
        unsafe {
            ::std::mem::transmute(self)
        }
    }
}

// Ensure we can use .coerce() to cast to our base types as well. Any type which
// our base interface can coerce from should be coercable from us as well.
impl<T: nsISupportsCoerce> nsILoginManagerPrompterCoerce for T {
    #[inline]
    fn coerce_from(v: &nsILoginManagerPrompter) -> &Self {
        T::coerce_from(v)
    }
}

// This struct represents the interface's VTable. A pointer to a statically
// allocated version of this struct is at the beginning of every nsILoginManagerPrompter
// object. It contains one pointer field for each method in the interface. In
// the case where we can't generate a binding for a method, we include a void
// pointer.
#[doc(hidden)]
#[repr(C)]
pub struct nsILoginManagerPrompterVTable {
    /// We need to include the members from the base interface's vtable at the start
    /// of the VTable definition.
    pub __base: nsISupportsVTable,

    /* void init (in nsIDOMWindow aWindow); */
    pub Init: unsafe extern "system" fn (this: *const nsILoginManagerPrompter, aWindow: *const nsIDOMWindow) -> nsresult,

    /* attribute nsIDOMElement browser; */
    pub GetBrowser: unsafe extern "system" fn (this: *const nsILoginManagerPrompter, aBrowser: *mut *const nsIDOMElement) -> nsresult,

    /* attribute nsIDOMElement browser; */
    pub SetBrowser: unsafe extern "system" fn (this: *const nsILoginManagerPrompter, aBrowser: *const nsIDOMElement) -> nsresult,

    /* attribute nsIDOMWindow opener; */
    pub GetOpener: unsafe extern "system" fn (this: *const nsILoginManagerPrompter, aOpener: *mut *const nsIDOMWindow) -> nsresult,

    /* attribute nsIDOMWindow opener; */
    pub SetOpener: unsafe extern "system" fn (this: *const nsILoginManagerPrompter, aOpener: *const nsIDOMWindow) -> nsresult,

    /* void promptToSavePassword (in nsILoginInfo aLogin); */
    pub PromptToSavePassword: unsafe extern "system" fn (this: *const nsILoginManagerPrompter, aLogin: *const nsILoginInfo) -> nsresult,

    /* void promptToChangePassword (in nsILoginInfo aOldLogin, in nsILoginInfo aNewLogin); */
    pub PromptToChangePassword: unsafe extern "system" fn (this: *const nsILoginManagerPrompter, aOldLogin: *const nsILoginInfo, aNewLogin: *const nsILoginInfo) -> nsresult,

    /* void promptToChangePasswordWithUsernames ([array, size_is (count)] in nsILoginInfo logins, in uint32_t count, in nsILoginInfo aNewLogin); */
    pub PromptToChangePasswordWithUsernames: unsafe extern "system" fn (this: *const nsILoginManagerPrompter, logins: *mut *const nsILoginInfo, count: uint32_t, aNewLogin: *const nsILoginInfo) -> nsresult,
}


// The implementations of the function wrappers which are exposed to rust code.
// Call these methods rather than manually calling through the VTable struct.
impl nsILoginManagerPrompter {

    /// ```text
    /// /**
    ///    * Initialize the prompter. Must be called before using other interfaces.
    ///    *
    ///    * @param aWindow
    ///    *        The window in which the user is doing some login-related action that's
    ///    *        resulting in a need to prompt them for something. The prompt
    ///    *        will be associated with this window (or, if a notification bar
        ///    *        is being used, topmost opener in some cases).
    ///    *
    ///    *        aWindow can be null if there is no associated window, e.g. in a JSM
    ///    *        or Sandbox. In this case there will be no checkbox to save the login
    ///    *        since the window is needed to know if this is a private context.
    ///    *
    ///    *        If this window is a content window, the corresponding window and browser
    ///    *        elements will be calculated. If this window is a chrome window, the
    ///    *        corresponding browser element needs to be set using setBrowser.
    ///    */
    /// ```
    ///

    /// `void init (in nsIDOMWindow aWindow);`
    #[inline]
    pub unsafe fn Init(&self, aWindow: *const nsIDOMWindow) -> nsresult {
        ((*self.vtable).Init)(self, aWindow)
    }


    /// ```text
    /// /**
    ///    * The browser this prompter is being created for.
    ///    * This is required if the init function received a chrome window as argument.
    ///    */
    /// ```
    ///

    /// `attribute nsIDOMElement browser;`
    #[inline]
    pub unsafe fn GetBrowser(&self, aBrowser: *mut *const nsIDOMElement) -> nsresult {
        ((*self.vtable).GetBrowser)(self, aBrowser)
    }


    /// ```text
    /// /**
    ///    * The browser this prompter is being created for.
    ///    * This is required if the init function received a chrome window as argument.
    ///    */
    /// ```
    ///

    /// `attribute nsIDOMElement browser;`
    #[inline]
    pub unsafe fn SetBrowser(&self, aBrowser: *const nsIDOMElement) -> nsresult {
        ((*self.vtable).SetBrowser)(self, aBrowser)
    }


    /// ```text
    /// /**
    ///    * The opener that was used to open the window passed to init.
    ///    * The opener can be used to determine in which window the prompt
    ///    * should be shown. Must be a content window that is not a frame window,
    ///    * make sure to pass the top window using e.g. window.top.
    ///    */
    /// ```
    ///

    /// `attribute nsIDOMWindow opener;`
    #[inline]
    pub unsafe fn GetOpener(&self, aOpener: *mut *const nsIDOMWindow) -> nsresult {
        ((*self.vtable).GetOpener)(self, aOpener)
    }


    /// ```text
    /// /**
    ///    * The opener that was used to open the window passed to init.
    ///    * The opener can be used to determine in which window the prompt
    ///    * should be shown. Must be a content window that is not a frame window,
    ///    * make sure to pass the top window using e.g. window.top.
    ///    */
    /// ```
    ///

    /// `attribute nsIDOMWindow opener;`
    #[inline]
    pub unsafe fn SetOpener(&self, aOpener: *const nsIDOMWindow) -> nsresult {
        ((*self.vtable).SetOpener)(self, aOpener)
    }


    /// ```text
    /// /**
    ///    * Ask the user if they want to save a login (Yes, Never, Not Now)
    ///    *
    ///    * @param aLogin
    ///    *        The login to be saved.
    ///    */
    /// ```
    ///

    /// `void promptToSavePassword (in nsILoginInfo aLogin);`
    #[inline]
    pub unsafe fn PromptToSavePassword(&self, aLogin: *const nsILoginInfo) -> nsresult {
        ((*self.vtable).PromptToSavePassword)(self, aLogin)
    }


    /// ```text
    /// /**
    ///    * Ask the user if they want to change a login's password or username.
    ///    * If the user consents, modifyLogin() will be called.
    ///    *
    ///    * @param aOldLogin
    ///    *        The existing login (with the old password).
    ///    * @param aNewLogin
    ///    *        The new login.
    ///    */
    /// ```
    ///

    /// `void promptToChangePassword (in nsILoginInfo aOldLogin, in nsILoginInfo aNewLogin);`
    #[inline]
    pub unsafe fn PromptToChangePassword(&self, aOldLogin: *const nsILoginInfo, aNewLogin: *const nsILoginInfo) -> nsresult {
        ((*self.vtable).PromptToChangePassword)(self, aOldLogin, aNewLogin)
    }


    /// ```text
    /// /**
    ///    * Ask the user if they want to change the password for one of
    ///    * multiple logins, when the caller can't determine exactly which
    ///    * login should be changed. If the user consents, modifyLogin() will
    ///    * be called.
    ///    *
    ///    * @param logins
    ///    *        An array of existing logins.
    ///    * @param count
    ///    *        (length of the array)
    ///    * @param aNewLogin
    ///    *        The new login.
    ///    *
    ///    * Note: Because the caller does not know the username of the login
    ///    *       to be changed, aNewLogin.username and aNewLogin.usernameField
    ///    *       will be set (using the user's selection) before modifyLogin()
    ///    *       is called.
    ///    */
    /// ```
    ///

    /// `void promptToChangePasswordWithUsernames ([array, size_is (count)] in nsILoginInfo logins, in uint32_t count, in nsILoginInfo aNewLogin);`
    #[inline]
    pub unsafe fn PromptToChangePasswordWithUsernames(&self, logins: *mut *const nsILoginInfo, count: uint32_t, aNewLogin: *const nsILoginInfo) -> nsresult {
        ((*self.vtable).PromptToChangePasswordWithUsernames)(self, logins, count, aNewLogin)
    }


}