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


/// `interface nsIGroupedSHistory : nsISupports`
///

/// ```text
/// /**
///  * nsIGroupedSHistory represent a combined session history across multiple
///  * root docshells (usually browser tabs). The participating nsISHistory can
///  * either be in chrome process or in content process, but nsIGroupedSHistory
///  * itself lives in chrome process. The communication is proxyed through
///  * nsIPartialSHistory.
///  */
/// ```
///

// 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 nsIGroupedSHistory {
    vtable: *const nsIGroupedSHistoryVTable,

    /// 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 nsIGroupedSHistory.
unsafe impl XpCom for nsIGroupedSHistory {
    const IID: nsIID = nsID(0x813e498d, 0x73a8, 0x449a,
        [0xbe, 0x09, 0x61, 0x87, 0xe6, 0x2c, 0x53, 0x52]);
}

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

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

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

    /* [infallible] readonly attribute unsigned long count; */
    pub GetCount: unsafe extern "system" fn (this: *const nsIGroupedSHistory, aCount: *mut libc::uint32_t) -> nsresult,

    /* readonly attribute nsIFrameLoader activeFrameLoader; */
    pub GetActiveFrameLoader: unsafe extern "system" fn (this: *const nsIGroupedSHistory, aActiveFrameLoader: *mut *const nsIFrameLoader) -> nsresult,

    /* void appendPartialSHistory (in nsIPartialSHistory aPartialHistory); */
    pub AppendPartialSHistory: unsafe extern "system" fn (this: *const nsIGroupedSHistory, aPartialHistory: *const nsIPartialSHistory) -> nsresult,

    /* void handleSHistoryUpdate (in nsIPartialSHistory aPartialHistory, in boolean aTruncate); */
    pub HandleSHistoryUpdate: unsafe extern "system" fn (this: *const nsIGroupedSHistory, aPartialHistory: *const nsIPartialSHistory, aTruncate: bool) -> nsresult,

    /* nsIFrameLoader gotoIndex (in unsigned long aGlobalIndex); */
    pub GotoIndex: unsafe extern "system" fn (this: *const nsIGroupedSHistory, aGlobalIndex: libc::uint32_t, _retval: *mut *const nsIFrameLoader) -> nsresult,

    /* void closeInactiveFrameLoaderOwners (); */
    pub CloseInactiveFrameLoaderOwners: unsafe extern "system" fn (this: *const nsIGroupedSHistory) -> nsresult,

    /* void addPrerenderingPartialSHistory (in nsIPartialSHistory aPrerendering, in long aId); */
    pub AddPrerenderingPartialSHistory: unsafe extern "system" fn (this: *const nsIGroupedSHistory, aPrerendering: *const nsIPartialSHistory, aId: libc::int32_t) -> nsresult,

    /* [implicit_jscontext] nsISupports activatePrerendering (in long aId); */
    /// Unable to generate binding because `jscontext is unsupported`
    pub ActivatePrerendering: *const ::libc::c_void,

    /* void cancelPrerendering (in long aId); */
    pub CancelPrerendering: unsafe extern "system" fn (this: *const nsIGroupedSHistory, aId: libc::int32_t) -> 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 nsIGroupedSHistory {


    /// `[infallible] readonly attribute unsigned long count;`
    #[inline]
    pub unsafe fn GetCount(&self) -> libc::uint32_t {
        let mut result = <libc::uint32_t as ::std::default::Default>::default();
        let _rv = ((*self.vtable).GetCount)(self, &mut result);
        debug_assert!(::nserror::NsresultExt::succeeded(_rv));
        result
    }


    /// ```text
    /// /**
    ///    * The currently active frameloader controlled by this nsIGroupedSHistory.
    ///    */
    /// ```
    ///

    /// `readonly attribute nsIFrameLoader activeFrameLoader;`
    #[inline]
    pub unsafe fn GetActiveFrameLoader(&self, aActiveFrameLoader: *mut *const nsIFrameLoader) -> nsresult {
        ((*self.vtable).GetActiveFrameLoader)(self, aActiveFrameLoader)
    }


    /// ```text
    /// /**
    ///    * Remove all partial histories after currently active one (if any) and then
    ///    * append the given partial session history to the end of the list.
    ///    */
    /// ```
    ///

    /// `void appendPartialSHistory (in nsIPartialSHistory aPartialHistory);`
    #[inline]
    pub unsafe fn AppendPartialSHistory(&self, aPartialHistory: *const nsIPartialSHistory) -> nsresult {
        ((*self.vtable).AppendPartialSHistory)(self, aPartialHistory)
    }


    /// ```text
    /// /**
    ///    * Notify the grouped session history that the active partial session history
    ///    * has been modified.
    ///    *
    ///    * @param aPartialHistory The partial history which was updated
    ///    * @param aTruncate If this parameter is true, all partial session histories
    ///    *                  after this one will be removed.
    ///    */
    /// ```
    ///

    /// `void handleSHistoryUpdate (in nsIPartialSHistory aPartialHistory, in boolean aTruncate);`
    #[inline]
    pub unsafe fn HandleSHistoryUpdate(&self, aPartialHistory: *const nsIPartialSHistory, aTruncate: bool) -> nsresult {
        ((*self.vtable).HandleSHistoryUpdate)(self, aPartialHistory, aTruncate)
    }


    /// ```text
    /// /**
    ///    * Find the proper partial session history and navigate to the entry
    ///    * corresponding to the given global index. Note it doesn't swap frameloaders,
    ///    * but rather return the target loader for the caller to swap.
    ///    *
    ///    * This function may throw NS_ERROR_NOT_AVAILABLE if the frameloader to swap
    ///    * to is dead.
    ///    *
    ///    * @param  aGlobalIndex
    ///    *         The global index to navigate to.
    ///    * @return The frameloader which needs to be swapped in, or null if no
    ///    *         frameloader needs to be swapped.
    ///    */
    /// ```
    ///

    /// `nsIFrameLoader gotoIndex (in unsigned long aGlobalIndex);`
    #[inline]
    pub unsafe fn GotoIndex(&self, aGlobalIndex: libc::uint32_t, _retval: *mut *const nsIFrameLoader) -> nsresult {
        ((*self.vtable).GotoIndex)(self, aGlobalIndex, _retval)
    }


    /// ```text
    /// /**
    ///    * Close the FrameLoaderOwners of the inactive PartialSHistories in this GlobalSHistory.
    ///    * This does not remove the PartialSHistories from the GroupedSHistory.
    ///    */
    /// ```
    ///

    /// `void closeInactiveFrameLoaderOwners ();`
    #[inline]
    pub unsafe fn CloseInactiveFrameLoaderOwners(&self, ) -> nsresult {
        ((*self.vtable).CloseInactiveFrameLoaderOwners)(self, )
    }


    /// ```text
    /// /**
    ///    * Add a partialSHistory as a "prerendering" partialSHistory. This
    ///    * partialSHistory's tab will have its lifetime managed by the
    ///    * GroupedSHistory, and will be closed when closeInactiveFrameLoaderOwners is
    ///    * called, or whenever a SHistory update is received.
    ///    */
    /// ```
    ///

    /// `void addPrerenderingPartialSHistory (in nsIPartialSHistory aPrerendering, in long aId);`
    #[inline]
    pub unsafe fn AddPrerenderingPartialSHistory(&self, aPrerendering: *const nsIPartialSHistory, aId: libc::int32_t) -> nsresult {
        ((*self.vtable).AddPrerenderingPartialSHistory)(self, aPrerendering, aId)
    }


    /// ```text
    /// /**
    ///    * Switch to the prerendering partialSHistory identified by aId, appending it after the current partialSHistory.
    ///    */
    /// ```
    ///

    /// `[implicit_jscontext] nsISupports activatePrerendering (in long aId);`
    const _ActivatePrerendering: () = ();

    /// ```text
    /// /**
    ///    * Cancel the prerendering with the given ID.
    ///    */
    /// ```
    ///

    /// `void cancelPrerendering (in long aId);`
    #[inline]
    pub unsafe fn CancelPrerendering(&self, aId: libc::int32_t) -> nsresult {
        ((*self.vtable).CancelPrerendering)(self, aId)
    }


}