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


/// `interface nsIGlobalHistory2 : 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 nsIGlobalHistory2 {
    vtable: *const nsIGlobalHistory2VTable,

    /// 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 nsIGlobalHistory2.
unsafe impl XpCom for nsIGlobalHistory2 {
    const IID: nsIID = nsID(0xcf777d42, 0x1270, 0x4b34,
        [0xbe, 0x7b, 0x29, 0x31, 0xc9, 0x3f, 0xed, 0xa5]);
}

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

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

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

    /* void addURI (in nsIURI aURI, in boolean aRedirect, in boolean aToplevel, in nsIURI aReferrer); */
    pub AddURI: unsafe extern "system" fn (this: *const nsIGlobalHistory2, aURI: *const nsIURI, aRedirect: bool, aToplevel: bool, aReferrer: *const nsIURI) -> nsresult,

    /* boolean isVisited (in nsIURI aURI); */
    pub IsVisited: unsafe extern "system" fn (this: *const nsIGlobalHistory2, aURI: *const nsIURI, _retval: *mut bool) -> nsresult,

    /* void setPageTitle (in nsIURI aURI, in AString aTitle); */
    pub SetPageTitle: unsafe extern "system" fn (this: *const nsIGlobalHistory2, aURI: *const nsIURI, aTitle: &::nsstring::nsAString) -> 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 nsIGlobalHistory2 {

    /// ```text
    /// /**
    ///      * Add a URI to global history
    ///      *
    ///      * @param aURI      the URI of the page
    ///      * @param aRedirect whether the URI was redirected to another location;
    ///      *                  this is 'true' for the original URI which is
    ///      *                  redirected.
    ///      * @param aToplevel whether the URI is loaded in a top-level window
    ///      * @param aReferrer the URI of the referring page
    ///      *
    ///      * @note  Docshell will not filter out URI schemes like chrome: data:
    ///      *        about: and view-source:.  Embedders should consider filtering out
    ///      *        these schemes and others, e.g. mailbox: for the main URI and the
    ///      *        referrer.
    ///      */
    /// ```
    ///

    /// `void addURI (in nsIURI aURI, in boolean aRedirect, in boolean aToplevel, in nsIURI aReferrer);`
    #[inline]
    pub unsafe fn AddURI(&self, aURI: *const nsIURI, aRedirect: bool, aToplevel: bool, aReferrer: *const nsIURI) -> nsresult {
        ((*self.vtable).AddURI)(self, aURI, aRedirect, aToplevel, aReferrer)
    }


    /// ```text
    /// /**
    ///      * Checks to see whether the given URI is in history.
    ///      *
    ///      * @param aURI the uri to the page
    ///      * @return true if a URI has been visited
    ///      */
    /// ```
    ///

    /// `boolean isVisited (in nsIURI aURI);`
    #[inline]
    pub unsafe fn IsVisited(&self, aURI: *const nsIURI, _retval: *mut bool) -> nsresult {
        ((*self.vtable).IsVisited)(self, aURI, _retval)
    }


    /// ```text
    /// /**
    ///      * Set the page title for the given uri. URIs that are not already in
    ///      * global history will not be added.
    ///      *
    ///      * @param aURI    the URI for which to set to the title
    ///      * @param aTitle  the page title
    ///      */
    /// ```
    ///

    /// `void setPageTitle (in nsIURI aURI, in AString aTitle);`
    #[inline]
    pub unsafe fn SetPageTitle(&self, aURI: *const nsIURI, aTitle: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).SetPageTitle)(self, aURI, aTitle)
    }


}