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


/// `interface nsILoginInfo : nsISupports`
///

/// ```text
/// /**
///  * An object containing information for a login stored by the
///  * password manager.
///  */
/// ```
///

// 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 nsILoginInfo {
    vtable: *const nsILoginInfoVTable,

    /// 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 nsILoginInfo.
unsafe impl XpCom for nsILoginInfo {
    const IID: nsIID = nsID(0xc41b7dff, 0x6b9b, 0x42fe,
        [0xb7, 0x8d, 0x11, 0x30, 0x51, 0xfa, 0xcb, 0x05]);
}

// 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 nsILoginInfo {
    #[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 nsILoginInfo.
// 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 nsILoginInfoCoerce {
    /// Cheaply cast a value of this type from a `nsILoginInfo`.
    fn coerce_from(v: &nsILoginInfo) -> &Self;
}

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

impl nsILoginInfo {
    /// Cast this `nsILoginInfo` to one of its base interfaces.
    #[inline]
    pub fn coerce<T: nsILoginInfoCoerce>(&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 nsILoginInfo {
    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> nsILoginInfoCoerce for T {
    #[inline]
    fn coerce_from(v: &nsILoginInfo) -> &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 nsILoginInfo
// 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 nsILoginInfoVTable {
    /// We need to include the members from the base interface's vtable at the start
    /// of the VTable definition.
    pub __base: nsISupportsVTable,

    /* attribute AString hostname; */
    pub GetHostname: unsafe extern "system" fn (this: *const nsILoginInfo, aHostname: &mut ::nsstring::nsAString) -> nsresult,

    /* attribute AString hostname; */
    pub SetHostname: unsafe extern "system" fn (this: *const nsILoginInfo, aHostname: &::nsstring::nsAString) -> nsresult,

    /* attribute AString formSubmitURL; */
    pub GetFormSubmitURL: unsafe extern "system" fn (this: *const nsILoginInfo, aFormSubmitURL: &mut ::nsstring::nsAString) -> nsresult,

    /* attribute AString formSubmitURL; */
    pub SetFormSubmitURL: unsafe extern "system" fn (this: *const nsILoginInfo, aFormSubmitURL: &::nsstring::nsAString) -> nsresult,

    /* attribute AString httpRealm; */
    pub GetHttpRealm: unsafe extern "system" fn (this: *const nsILoginInfo, aHttpRealm: &mut ::nsstring::nsAString) -> nsresult,

    /* attribute AString httpRealm; */
    pub SetHttpRealm: unsafe extern "system" fn (this: *const nsILoginInfo, aHttpRealm: &::nsstring::nsAString) -> nsresult,

    /* attribute AString username; */
    pub GetUsername: unsafe extern "system" fn (this: *const nsILoginInfo, aUsername: &mut ::nsstring::nsAString) -> nsresult,

    /* attribute AString username; */
    pub SetUsername: unsafe extern "system" fn (this: *const nsILoginInfo, aUsername: &::nsstring::nsAString) -> nsresult,

    /* attribute AString usernameField; */
    pub GetUsernameField: unsafe extern "system" fn (this: *const nsILoginInfo, aUsernameField: &mut ::nsstring::nsAString) -> nsresult,

    /* attribute AString usernameField; */
    pub SetUsernameField: unsafe extern "system" fn (this: *const nsILoginInfo, aUsernameField: &::nsstring::nsAString) -> nsresult,

    /* attribute AString password; */
    pub GetPassword: unsafe extern "system" fn (this: *const nsILoginInfo, aPassword: &mut ::nsstring::nsAString) -> nsresult,

    /* attribute AString password; */
    pub SetPassword: unsafe extern "system" fn (this: *const nsILoginInfo, aPassword: &::nsstring::nsAString) -> nsresult,

    /* attribute AString passwordField; */
    pub GetPasswordField: unsafe extern "system" fn (this: *const nsILoginInfo, aPasswordField: &mut ::nsstring::nsAString) -> nsresult,

    /* attribute AString passwordField; */
    pub SetPasswordField: unsafe extern "system" fn (this: *const nsILoginInfo, aPasswordField: &::nsstring::nsAString) -> nsresult,

    /* void init (in AString aHostname, in AString aFormSubmitURL, in AString aHttpRealm, in AString aUsername, in AString aPassword, in AString aUsernameField, in AString aPasswordField); */
    pub Init: unsafe extern "system" fn (this: *const nsILoginInfo, aHostname: &::nsstring::nsAString, aFormSubmitURL: &::nsstring::nsAString, aHttpRealm: &::nsstring::nsAString, aUsername: &::nsstring::nsAString, aPassword: &::nsstring::nsAString, aUsernameField: &::nsstring::nsAString, aPasswordField: &::nsstring::nsAString) -> nsresult,

    /* boolean equals (in nsILoginInfo aLoginInfo); */
    pub Equals: unsafe extern "system" fn (this: *const nsILoginInfo, aLoginInfo: *const nsILoginInfo, _retval: *mut bool) -> nsresult,

    /* boolean matches (in nsILoginInfo aLoginInfo, in boolean ignorePassword); */
    pub Matches: unsafe extern "system" fn (this: *const nsILoginInfo, aLoginInfo: *const nsILoginInfo, ignorePassword: bool, _retval: *mut bool) -> nsresult,

    /* nsILoginInfo clone (); */
    pub Clone: unsafe extern "system" fn (this: *const nsILoginInfo, _retval: *mut *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 nsILoginInfo {

    /// ```text
    /// /**
    ///    * The hostname the login applies to.
    ///    *
    ///    * The hostname should be formatted as an URL. For example,
    ///    * "https://site.com", "http://site.com:1234", "ftp://ftp.site.com".
    ///    */
    /// ```
    ///

    /// `attribute AString hostname;`
    #[inline]
    pub unsafe fn GetHostname(&self, aHostname: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).GetHostname)(self, aHostname)
    }


    /// ```text
    /// /**
    ///    * The hostname the login applies to.
    ///    *
    ///    * The hostname should be formatted as an URL. For example,
    ///    * "https://site.com", "http://site.com:1234", "ftp://ftp.site.com".
    ///    */
    /// ```
    ///

    /// `attribute AString hostname;`
    #[inline]
    pub unsafe fn SetHostname(&self, aHostname: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).SetHostname)(self, aHostname)
    }


    /// ```text
    /// /**
    ///    * The URL a form-based login was submitted to.
    ///    *
    ///    * For logins obtained from HTML forms, this field is the |action|
    ///    * attribute from the |form| element, with the path removed. For
    ///    * example "http://www.site.com". [Forms with no |action| attribute
        ///    * default to submitting to their origin URL, so we store that.]
    ///    *
    ///    * For logins obtained from a HTTP or FTP protocol authentication,
    ///    * this field is NULL.
    ///    */
    /// ```
    ///

    /// `attribute AString formSubmitURL;`
    #[inline]
    pub unsafe fn GetFormSubmitURL(&self, aFormSubmitURL: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).GetFormSubmitURL)(self, aFormSubmitURL)
    }


    /// ```text
    /// /**
    ///    * The URL a form-based login was submitted to.
    ///    *
    ///    * For logins obtained from HTML forms, this field is the |action|
    ///    * attribute from the |form| element, with the path removed. For
    ///    * example "http://www.site.com". [Forms with no |action| attribute
        ///    * default to submitting to their origin URL, so we store that.]
    ///    *
    ///    * For logins obtained from a HTTP or FTP protocol authentication,
    ///    * this field is NULL.
    ///    */
    /// ```
    ///

    /// `attribute AString formSubmitURL;`
    #[inline]
    pub unsafe fn SetFormSubmitURL(&self, aFormSubmitURL: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).SetFormSubmitURL)(self, aFormSubmitURL)
    }


    /// ```text
    /// /**
    ///    * The HTTP Realm a login was requested for.
    ///    *
    ///    * When an HTTP server sends a 401 result, the WWW-Authenticate
    ///    * header includes a realm to identify the "protection space." See
    ///    * RFC2617. If the response sent has a missing or blank realm, the
    ///    * hostname is used instead.
    ///    *
    ///    * For logins obtained from HTML forms, this field is NULL.
    ///    */
    /// ```
    ///

    /// `attribute AString httpRealm;`
    #[inline]
    pub unsafe fn GetHttpRealm(&self, aHttpRealm: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).GetHttpRealm)(self, aHttpRealm)
    }


    /// ```text
    /// /**
    ///    * The HTTP Realm a login was requested for.
    ///    *
    ///    * When an HTTP server sends a 401 result, the WWW-Authenticate
    ///    * header includes a realm to identify the "protection space." See
    ///    * RFC2617. If the response sent has a missing or blank realm, the
    ///    * hostname is used instead.
    ///    *
    ///    * For logins obtained from HTML forms, this field is NULL.
    ///    */
    /// ```
    ///

    /// `attribute AString httpRealm;`
    #[inline]
    pub unsafe fn SetHttpRealm(&self, aHttpRealm: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).SetHttpRealm)(self, aHttpRealm)
    }


    /// ```text
    /// /**
    ///    * The username for the login.
    ///    */
    /// ```
    ///

    /// `attribute AString username;`
    #[inline]
    pub unsafe fn GetUsername(&self, aUsername: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).GetUsername)(self, aUsername)
    }


    /// ```text
    /// /**
    ///    * The username for the login.
    ///    */
    /// ```
    ///

    /// `attribute AString username;`
    #[inline]
    pub unsafe fn SetUsername(&self, aUsername: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).SetUsername)(self, aUsername)
    }


    /// ```text
    /// /**
    ///    * The |name| attribute for the username input field.
    ///    *
    ///    * For logins obtained from a HTTP or FTP protocol authentication,
    ///    * this field is an empty string.
    ///    */
    /// ```
    ///

    /// `attribute AString usernameField;`
    #[inline]
    pub unsafe fn GetUsernameField(&self, aUsernameField: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).GetUsernameField)(self, aUsernameField)
    }


    /// ```text
    /// /**
    ///    * The |name| attribute for the username input field.
    ///    *
    ///    * For logins obtained from a HTTP or FTP protocol authentication,
    ///    * this field is an empty string.
    ///    */
    /// ```
    ///

    /// `attribute AString usernameField;`
    #[inline]
    pub unsafe fn SetUsernameField(&self, aUsernameField: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).SetUsernameField)(self, aUsernameField)
    }


    /// ```text
    /// /**
    ///    * The password for the login.
    ///    */
    /// ```
    ///

    /// `attribute AString password;`
    #[inline]
    pub unsafe fn GetPassword(&self, aPassword: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).GetPassword)(self, aPassword)
    }


    /// ```text
    /// /**
    ///    * The password for the login.
    ///    */
    /// ```
    ///

    /// `attribute AString password;`
    #[inline]
    pub unsafe fn SetPassword(&self, aPassword: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).SetPassword)(self, aPassword)
    }


    /// ```text
    /// /**
    ///    * The |name| attribute for the password input field.
    ///    *
    ///    * For logins obtained from a HTTP or FTP protocol authentication,
    ///    * this field is an empty string.
    ///    */
    /// ```
    ///

    /// `attribute AString passwordField;`
    #[inline]
    pub unsafe fn GetPasswordField(&self, aPasswordField: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).GetPasswordField)(self, aPasswordField)
    }


    /// ```text
    /// /**
    ///    * The |name| attribute for the password input field.
    ///    *
    ///    * For logins obtained from a HTTP or FTP protocol authentication,
    ///    * this field is an empty string.
    ///    */
    /// ```
    ///

    /// `attribute AString passwordField;`
    #[inline]
    pub unsafe fn SetPasswordField(&self, aPasswordField: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).SetPasswordField)(self, aPasswordField)
    }


    /// ```text
    /// /**
    ///    * Initialize a newly created nsLoginInfo object.
    ///    *
    ///    * The arguments are the fields for the new object.
    ///    */
    /// ```
    ///

    /// `void init (in AString aHostname, in AString aFormSubmitURL, in AString aHttpRealm, in AString aUsername, in AString aPassword, in AString aUsernameField, in AString aPasswordField);`
    #[inline]
    pub unsafe fn Init(&self, aHostname: &::nsstring::nsAString, aFormSubmitURL: &::nsstring::nsAString, aHttpRealm: &::nsstring::nsAString, aUsername: &::nsstring::nsAString, aPassword: &::nsstring::nsAString, aUsernameField: &::nsstring::nsAString, aPasswordField: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).Init)(self, aHostname, aFormSubmitURL, aHttpRealm, aUsername, aPassword, aUsernameField, aPasswordField)
    }


    /// ```text
    /// /**
    ///    * Test for strict equality with another nsILoginInfo object.
    ///    *
    ///    * @param aLoginInfo
    ///    *        The other object to test.
    ///    */
    /// ```
    ///

    /// `boolean equals (in nsILoginInfo aLoginInfo);`
    #[inline]
    pub unsafe fn Equals(&self, aLoginInfo: *const nsILoginInfo, _retval: *mut bool) -> nsresult {
        ((*self.vtable).Equals)(self, aLoginInfo, _retval)
    }


    /// ```text
    /// /**
    ///    * Test for loose equivalency with another nsILoginInfo object. The
    ///    * passwordField and usernameField values are ignored, and the password
    ///    * values may be optionally ignored. If one login's formSubmitURL is an
    ///    * empty string (but not null), it will be treated as a wildcard. [The
        ///    * blank value indicates the login was stored before bug 360493 was fixed.]
    ///    *
    ///    * @param aLoginInfo
    ///    *        The other object to test.
    ///    * @param ignorePassword
    ///    *        If true, ignore the password when checking for match.
    ///    */
    /// ```
    ///

    /// `boolean matches (in nsILoginInfo aLoginInfo, in boolean ignorePassword);`
    #[inline]
    pub unsafe fn Matches(&self, aLoginInfo: *const nsILoginInfo, ignorePassword: bool, _retval: *mut bool) -> nsresult {
        ((*self.vtable).Matches)(self, aLoginInfo, ignorePassword, _retval)
    }


    /// ```text
    /// /**
    ///    * Create an identical copy of the login, duplicating all of the login's
    ///    * nsILoginInfo and nsILoginMetaInfo properties.
    ///    *
    ///    * This allows code to be forwards-compatible, when additional properties
    ///    * are added to nsILoginMetaInfo (or nsILoginInfo) in the future.
    ///    */
    /// ```
    ///

    /// `nsILoginInfo clone ();`
    #[inline]
    pub unsafe fn Clone(&self, _retval: *mut *const nsILoginInfo) -> nsresult {
        ((*self.vtable).Clone)(self, _retval)
    }


}