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


/// `interface nsIPartialSHistory : nsISupports`
///

/// ```text
/// /**
///  * nsIPartialSHistory represents a part of nsIGroupedSHistory. It associates to
///  * a "partial" nsISHistory in either local or remote process.
///  */
/// ```
///

// 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 nsIPartialSHistory {
    vtable: *const nsIPartialSHistoryVTable,

    /// 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 nsIPartialSHistory.
unsafe impl XpCom for nsIPartialSHistory {
    const IID: nsIID = nsID(0x5cd75e28, 0x838c, 0x4a0a,
        [0x97, 0x2e, 0x60, 0x05, 0xf7, 0x36, 0xef, 0x7a]);
}

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

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

impl nsIPartialSHistory {
    /// Cast this `nsIPartialSHistory` to one of its base interfaces.
    #[inline]
    pub fn coerce<T: nsIPartialSHistoryCoerce>(&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 nsIPartialSHistory {
    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> nsIPartialSHistoryCoerce for T {
    #[inline]
    fn coerce_from(v: &nsIPartialSHistory) -> &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 nsIPartialSHistory
// 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 nsIPartialSHistoryVTable {
    /// 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 nsIPartialSHistory, aCount: *mut libc::uint32_t) -> nsresult,

    /* [infallible] readonly attribute long globalIndex; */
    pub GetGlobalIndex: unsafe extern "system" fn (this: *const nsIPartialSHistory, aGlobalIndex: *mut libc::int32_t) -> nsresult,

    /* [infallible] readonly attribute unsigned long globalIndexOffset; */
    pub GetGlobalIndexOffset: unsafe extern "system" fn (this: *const nsIPartialSHistory, aGlobalIndexOffset: *mut libc::uint32_t) -> nsresult,

    /* readonly attribute nsIFrameLoader ownerFrameLoader; */
    pub GetOwnerFrameLoader: unsafe extern "system" fn (this: *const nsIPartialSHistory, aOwnerFrameLoader: *mut *const nsIFrameLoader) -> nsresult,

    /* readonly attribute nsIGroupedSHistory groupedSHistory; */
    pub GetGroupedSHistory: unsafe extern "system" fn (this: *const nsIPartialSHistory, aGroupedSHistory: *mut *const nsIGroupedSHistory) -> nsresult,

    /* [infallible] attribute long activeState; */
    pub GetActiveState: unsafe extern "system" fn (this: *const nsIPartialSHistory, aActiveState: *mut libc::int32_t) -> nsresult,

    /* [infallible] attribute long activeState; */
    pub SetActiveState: unsafe extern "system" fn (this: *const nsIPartialSHistory, aActiveState: libc::int32_t) -> nsresult,

    /* void onAttachGroupedSHistory (in nsIGroupedSHistory aGroup, in unsigned long aOffset); */
    pub OnAttachGroupedSHistory: unsafe extern "system" fn (this: *const nsIPartialSHistory, aGroup: *const nsIGroupedSHistory, aOffset: libc::uint32_t) -> nsresult,

    /* void handleSHistoryUpdate (in unsigned long aCount, in unsigned long aLocalIndex, in boolean aTruncate); */
    pub HandleSHistoryUpdate: unsafe extern "system" fn (this: *const nsIPartialSHistory, aCount: libc::uint32_t, aLocalIndex: libc::uint32_t, aTruncate: bool) -> nsresult,

    /* void onActive (in unsigned long aGlobalLength, in unsigned long aTargetLocalIndex); */
    pub OnActive: unsafe extern "system" fn (this: *const nsIPartialSHistory, aGlobalLength: libc::uint32_t, aTargetLocalIndex: libc::uint32_t) -> nsresult,

    /* void onDeactive (); */
    pub OnDeactive: unsafe extern "system" fn (this: *const nsIPartialSHistory) -> 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 nsIPartialSHistory {

    pub const STATE_INACTIVE: i64 = 0;


    pub const STATE_ACTIVE: i64 = 1;


    pub const STATE_PRERENDER: i64 = 2;


    /// `[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
    }



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



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



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



    /// `readonly attribute nsIGroupedSHistory groupedSHistory;`
    #[inline]
    pub unsafe fn GetGroupedSHistory(&self, aGroupedSHistory: *mut *const nsIGroupedSHistory) -> nsresult {
        ((*self.vtable).GetGroupedSHistory)(self, aGroupedSHistory)
    }



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



    /// `[infallible] attribute long activeState;`
    #[inline]
    pub unsafe fn SetActiveState(&self, aActiveState: libc::int32_t) -> nsresult {
        ((*self.vtable).SetActiveState)(self, aActiveState)
    }


    /// ```text
    /// /**
    ///    * Notify that it's been added to a grouped session history. It also implies
    ///    * it's becoming the active partial history of the group.
    ///    *
    ///    * @param aGroup                 The GroupedSHistory which this partialSHistory
    ///    *                               is joining.
    ///    *
    ///    * @param aOffset                The number of entries in preceding partial
    ///    *                               session histories.
    ///    */
    /// ```
    ///

    /// `void onAttachGroupedSHistory (in nsIGroupedSHistory aGroup, in unsigned long aOffset);`
    #[inline]
    pub unsafe fn OnAttachGroupedSHistory(&self, aGroup: *const nsIGroupedSHistory, aOffset: libc::uint32_t) -> nsresult {
        ((*self.vtable).OnAttachGroupedSHistory)(self, aGroup, aOffset)
    }


    /// ```text
    /// /**
    ///    * This method is used by the TabParent to notify the PartialSHistory
    ///    * that the state of its corresponding nsISHistory in the content process
    ///    * has been updated. It is unused in the in-process case.
    ///    *
    ///    * @param aCount      The number of entries in the associated session history.
    ///    * @param aLocalIndex The local index of the currently active entry in the
    ///    *                    associated session history
    ///    */
    /// ```
    ///

    /// `void handleSHistoryUpdate (in unsigned long aCount, in unsigned long aLocalIndex, in boolean aTruncate);`
    #[inline]
    pub unsafe fn HandleSHistoryUpdate(&self, aCount: libc::uint32_t, aLocalIndex: libc::uint32_t, aTruncate: bool) -> nsresult {
        ((*self.vtable).HandleSHistoryUpdate)(self, aCount, aLocalIndex, aTruncate)
    }


    /// ```text
    /// /**
    ///    * Notify that the partial session history has been swapped in as the active
    ///    * session history. Only an active session history can possibly add / remove /
    ///    * replace its history entries.
    ///    *
    ///    * @param aGlobalLength      The up-to-date global length.
    ///    * @param aTargetLocalIndex  The local index to navigate to.
    ///    */
    /// ```
    ///

    /// `void onActive (in unsigned long aGlobalLength, in unsigned long aTargetLocalIndex);`
    #[inline]
    pub unsafe fn OnActive(&self, aGlobalLength: libc::uint32_t, aTargetLocalIndex: libc::uint32_t) -> nsresult {
        ((*self.vtable).OnActive)(self, aGlobalLength, aTargetLocalIndex)
    }


    /// ```text
    /// /**
    ///    * Notify that the partial session history has been swapped out and is no
    ///    * longer active.
    ///    */
    /// ```
    ///

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


}