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


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

    /// 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 nsISHistoryInternal.
unsafe impl XpCom for nsISHistoryInternal {
    const IID: nsIID = nsID(0x3dfb2f54, 0x378d, 0x4d3c,
        [0xa9, 0xf9, 0x95, 0xdd, 0x26, 0x73, 0x24, 0x8c]);
}

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

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

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

    /* void addEntry (in nsISHEntry aEntry, in boolean aPersist); */
    pub AddEntry: unsafe extern "system" fn (this: *const nsISHistoryInternal, aEntry: *const nsISHEntry, aPersist: bool) -> nsresult,

    /* readonly attribute nsISHTransaction rootTransaction; */
    pub GetRootTransaction: unsafe extern "system" fn (this: *const nsISHistoryInternal, aRootTransaction: *mut *const nsISHTransaction) -> nsresult,

    /* void setRootDocShell (in nsIDocShell rootDocShell); */
    pub SetRootDocShell: unsafe extern "system" fn (this: *const nsISHistoryInternal, rootDocShell: *const nsIDocShell) -> nsresult,

    /* void updateIndex (); */
    pub UpdateIndex: unsafe extern "system" fn (this: *const nsISHistoryInternal) -> nsresult,

    /* void replaceEntry (in long aIndex, in nsISHEntry aReplaceEntry); */
    pub ReplaceEntry: unsafe extern "system" fn (this: *const nsISHistoryInternal, aIndex: libc::int32_t, aReplaceEntry: *const nsISHEntry) -> nsresult,

    /* boolean notifyOnHistoryReload (in nsIURI aReloadURI, in unsigned long aReloadFlags); */
    pub NotifyOnHistoryReload: unsafe extern "system" fn (this: *const nsISHistoryInternal, aReloadURI: *const nsIURI, aReloadFlags: libc::uint32_t, _retval: *mut bool) -> nsresult,

    /* void evictOutOfRangeContentViewers (in long aIndex); */
    pub EvictOutOfRangeContentViewers: unsafe extern "system" fn (this: *const nsISHistoryInternal, aIndex: libc::int32_t) -> nsresult,

    /* void evictExpiredContentViewerForEntry (in nsIBFCacheEntry aEntry); */
    pub EvictExpiredContentViewerForEntry: unsafe extern "system" fn (this: *const nsISHistoryInternal, aEntry: *const nsIBFCacheEntry) -> nsresult,

    /* void evictAllContentViewers (); */
    pub EvictAllContentViewers: unsafe extern "system" fn (this: *const nsISHistoryInternal) -> nsresult,

    /* void addToExpirationTracker (in nsIBFCacheEntry aEntry); */
    pub AddToExpirationTracker: unsafe extern "system" fn (this: *const nsISHistoryInternal, aEntry: *const nsIBFCacheEntry) -> nsresult,

    /* void removeFromExpirationTracker (in nsIBFCacheEntry aEntry); */
    pub RemoveFromExpirationTracker: unsafe extern "system" fn (this: *const nsISHistoryInternal, aEntry: *const nsIBFCacheEntry) -> nsresult,

    /* [noscript,notxpcom] void RemoveDynEntries (in long aIndex, in nsISHContainer aContainer); */
    pub RemoveDynEntries: unsafe extern "system" fn (this: *const nsISHistoryInternal, aIndex: libc::int32_t, aContainer: *const nsISHContainer) -> libc::c_void,

    /* [noscript,notxpcom] void RemoveDynEntriesForBFCacheEntry (in nsIBFCacheEntry aEntry); */
    pub RemoveDynEntriesForBFCacheEntry: unsafe extern "system" fn (this: *const nsISHistoryInternal, aEntry: *const nsIBFCacheEntry) -> libc::c_void,

    /* [noscript,notxpcom] void RemoveEntries (in nsDocshellIDArray aIDs, in long aStartIndex); */
    /// Unable to generate binding because `native type nsTArray<nsID> is unsupported`
    pub RemoveEntries: *const ::libc::c_void,
}


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

    /// ```text
    /// /**
    ///    * Add a new Entry to the History List
    ///    * @param aEntry - The entry to add
    ///    * @param aPersist - If true this specifies that the entry should persist
    ///    * in the list.  If false, this means that when new entries are added
    ///    * this element will not appear in the session history list.
    ///    */
    /// ```
    ///

    /// `void addEntry (in nsISHEntry aEntry, in boolean aPersist);`
    #[inline]
    pub unsafe fn AddEntry(&self, aEntry: *const nsISHEntry, aPersist: bool) -> nsresult {
        ((*self.vtable).AddEntry)(self, aEntry, aPersist)
    }


    /// ```text
    /// /**
    ///    * Get the root transaction
    ///    */
    /// ```
    ///

    /// `readonly attribute nsISHTransaction rootTransaction;`
    #[inline]
    pub unsafe fn GetRootTransaction(&self, aRootTransaction: *mut *const nsISHTransaction) -> nsresult {
        ((*self.vtable).GetRootTransaction)(self, aRootTransaction)
    }


    /// ```text
    /// /**
    ///    * Sets the toplevel docshell object to which this SHistory object belongs to.
    ///    */
    /// ```
    ///

    /// `void setRootDocShell (in nsIDocShell rootDocShell);`
    #[inline]
    pub unsafe fn SetRootDocShell(&self, rootDocShell: *const nsIDocShell) -> nsresult {
        ((*self.vtable).SetRootDocShell)(self, rootDocShell)
    }


    /// ```text
    /// /**
    ///    * Update the index maintained by sessionHistory
    ///    */
    /// ```
    ///

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


    /// ```text
    /// /**
    ///    * Replace the nsISHEntry at a particular index
    ///    * @param aIndex - The index at which the entry should be replaced
    ///    * @param aReplaceEntry - The replacement entry for the index.
    ///    */
    /// ```
    ///

    /// `void replaceEntry (in long aIndex, in nsISHEntry aReplaceEntry);`
    #[inline]
    pub unsafe fn ReplaceEntry(&self, aIndex: libc::int32_t, aReplaceEntry: *const nsISHEntry) -> nsresult {
        ((*self.vtable).ReplaceEntry)(self, aIndex, aReplaceEntry)
    }


    /// ```text
    /// /**
    ///    * Notifies all registered session history listeners about an impending
    ///    * reload.
    ///    *
    ///    * @param aReloadURI    The URI of the document to be reloaded.
    ///    * @param aReloadFlags  Flags that indicate how the document is to be
    ///    *                      refreshed. See constants on the nsIWebNavigation
    ///    *                      interface.
    ///    * @return              Whether the operation can proceed.
    ///    */
    /// ```
    ///

    /// `boolean notifyOnHistoryReload (in nsIURI aReloadURI, in unsigned long aReloadFlags);`
    #[inline]
    pub unsafe fn NotifyOnHistoryReload(&self, aReloadURI: *const nsIURI, aReloadFlags: libc::uint32_t, _retval: *mut bool) -> nsresult {
        ((*self.vtable).NotifyOnHistoryReload)(self, aReloadURI, aReloadFlags, _retval)
    }


    /// ```text
    /// /**
    ///     * Evict content viewers which don't lie in the "safe" range around aIndex.
    ///     * In practice, this should leave us with no more than gHistoryMaxViewers
    ///     * viewers associated with this SHistory object.
    ///     *
    ///     * Also make sure that the total number of content viewers in all windows is
    ///     * not greater than our global max; if it is, evict viewers as appropriate.
    ///     *
    ///     * @param aIndex - The index around which the "safe" range is centered.  In
    ///     *   general, if you just navigated the history, aIndex should be the index
    ///     *   history was navigated to.
    ///     */
    /// ```
    ///

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


    /// ```text
    /// /**
    ///     * Evict the content viewer associated with a bfcache entry
    ///     * that has timed out.
    ///     */
    /// ```
    ///

    /// `void evictExpiredContentViewerForEntry (in nsIBFCacheEntry aEntry);`
    #[inline]
    pub unsafe fn EvictExpiredContentViewerForEntry(&self, aEntry: *const nsIBFCacheEntry) -> nsresult {
        ((*self.vtable).EvictExpiredContentViewerForEntry)(self, aEntry)
    }


    /// ```text
    /// /**
    ///     * Evict all the content viewers in this session history
    ///     */
    /// ```
    ///

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


    /// ```text
    /// /**
    ///     * Add a BFCache entry to expiration tracker so it gets evicted on expiration.
    ///     */
    /// ```
    ///

    /// `void addToExpirationTracker (in nsIBFCacheEntry aEntry);`
    #[inline]
    pub unsafe fn AddToExpirationTracker(&self, aEntry: *const nsIBFCacheEntry) -> nsresult {
        ((*self.vtable).AddToExpirationTracker)(self, aEntry)
    }


    /// ```text
    /// /**
    ///     * Remove a BFCache entry from expiration tracker.
    ///     */
    /// ```
    ///

    /// `void removeFromExpirationTracker (in nsIBFCacheEntry aEntry);`
    #[inline]
    pub unsafe fn RemoveFromExpirationTracker(&self, aEntry: *const nsIBFCacheEntry) -> nsresult {
        ((*self.vtable).RemoveFromExpirationTracker)(self, aEntry)
    }


    /// ```text
    /// /**
    ///     * Remove dynamic entries found at given index.
    ///     *
    ///     * @param aIndex
    ///     *        Index to remove dynamic entries from. It will be passed to
    ///     *        RemoveEntries as aStartIndex.
    ///     * @param aContainer (optional)
    ///     *        The container to start looking for dynamic entries. Only the
    ///     *        dynamic descendants of the container will be removed. If not given,
    ///     *        all dynamic entries at the index will be removed.
    ///     */
    /// ```
    ///

    /// `[noscript,notxpcom] void RemoveDynEntries (in long aIndex, in nsISHContainer aContainer);`
    #[inline]
    pub unsafe fn RemoveDynEntries(&self, aIndex: libc::int32_t, aContainer: *const nsISHContainer) -> libc::c_void {
        ((*self.vtable).RemoveDynEntries)(self, aIndex, aContainer)
    }


    /// ```text
    /// /**
    ///     * Similar to RemoveDynEntries, but instead of specifying an index, use the
    ///     * given BFCacheEntry to find the index and remove dynamic entries from the
    ///     * index.
    ///     *
    ///     * The method takes no effect if the bfcache entry is not or no longer hold
    ///     * by the SHistory instance.
    ///     *
    ///     * @param aEntry
    ///     *        The bfcache entry to look up for index to remove dynamic entries
    ///     *        from.
    ///     */
    /// ```
    ///

    /// `[noscript,notxpcom] void RemoveDynEntriesForBFCacheEntry (in nsIBFCacheEntry aEntry);`
    #[inline]
    pub unsafe fn RemoveDynEntriesForBFCacheEntry(&self, aEntry: *const nsIBFCacheEntry) -> libc::c_void {
        ((*self.vtable).RemoveDynEntriesForBFCacheEntry)(self, aEntry)
    }


    /// ```text
    /// /**
    ///     * Removes entries from the history if their docshellID is in
    ///     * aIDs array.
    ///     */
    /// ```
    ///

    /// `[noscript,notxpcom] void RemoveEntries (in nsDocshellIDArray aIDs, in long aStartIndex);`
    const _RemoveEntries: () = ();

}