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


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

    /// 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 nsIBrowserHistory.
unsafe impl XpCom for nsIBrowserHistory {
    const IID: nsIID = nsID(0x20d31479, 0x38de, 0x49f4,
        [0x93, 0x00, 0x56, 0x6d, 0x6e, 0x83, 0x4c, 0x66]);
}

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

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

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

    /* void removePagesFromHost (in AUTF8String aHost, in boolean aEntireDomain); */
    pub RemovePagesFromHost: unsafe extern "system" fn (this: *const nsIBrowserHistory, aHost: &::nsstring::nsACString, aEntireDomain: bool) -> nsresult,

    /* void removePagesByTimeframe (in PRTime aBeginTime, in PRTime aEndTime); */
    pub RemovePagesByTimeframe: unsafe extern "system" fn (this: *const nsIBrowserHistory, aBeginTime: PRTime, aEndTime: PRTime) -> 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 nsIBrowserHistory {

    /// ```text
    /// /**
    ///      * Removes all global history information about pages for a given host.
    ///      *
    ///      * @param aHost
    ///      *        Hostname to be removed.
    ///      *        An empty host name means local files and anything else with no
    ///      *        hostname.  You can also pass in the localized "(local files)"
    ///      *        title given to you from a history query to remove all
    ///      *        history information from local files.
    ///      * @param aEntireDomain
    ///      *        If true, will also delete pages from sub hosts (so if
        ///      *        passed in "microsoft.com" will delete "www.microsoft.com",
        ///      *        "msdn.microsoft.com", etc.).
    ///      *
    ///      * @note The removal happens in a batch.
    ///      */
    /// ```
    ///

    /// `void removePagesFromHost (in AUTF8String aHost, in boolean aEntireDomain);`
    #[inline]
    pub unsafe fn RemovePagesFromHost(&self, aHost: &::nsstring::nsACString, aEntireDomain: bool) -> nsresult {
        ((*self.vtable).RemovePagesFromHost)(self, aHost, aEntireDomain)
    }


    /// ```text
    /// /**
    ///      * Removes all pages for a given timeframe.
    ///      * Limits are included: aBeginTime <= timeframe <= aEndTime
    ///      *
    ///      * @param aBeginTime
    ///      *        Microseconds from epoch, representing the initial time.
    ///      * @param aEndTime
    ///      *        Microseconds from epoch, representing the final time.
    ///      *
    ///      * @note The removal happens in a batch.
    ///      */
    /// ```
    ///

    /// `void removePagesByTimeframe (in PRTime aBeginTime, in PRTime aEndTime);`
    #[inline]
    pub unsafe fn RemovePagesByTimeframe(&self, aBeginTime: PRTime, aEndTime: PRTime) -> nsresult {
        ((*self.vtable).RemovePagesByTimeframe)(self, aBeginTime, aEndTime)
    }


}