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


/// `interface nsISessionStoreUtilsFrameCallback : nsISupports`
///

/// ```text
/// /**
///  * A callback passed to nsISessionStoreUtils.forEachNonDynamicChildFrame().
///  */
/// ```
///

// 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 nsISessionStoreUtilsFrameCallback {
    vtable: *const nsISessionStoreUtilsFrameCallbackVTable,

    /// 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 nsISessionStoreUtilsFrameCallback.
unsafe impl XpCom for nsISessionStoreUtilsFrameCallback {
    const IID: nsIID = nsID(0x8199ebf7, 0x76c0, 0x43d6,
        [0xbc, 0xbe, 0x91, 0x3d, 0xd3, 0xde, 0x3e, 0xbf]);
}

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

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

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

    /* void handleFrame (in mozIDOMWindowProxy frame, in unsigned long index); */
    pub HandleFrame: unsafe extern "system" fn (this: *const nsISessionStoreUtilsFrameCallback, frame: *const mozIDOMWindowProxy, index: libc::uint32_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 nsISessionStoreUtilsFrameCallback {

    /// ```text
    /// /**
    ///    * handleFrame() will be called once for each non-dynamic child frame of the
    ///    * given parent |frame|. The second argument is the |index| of the frame in
    ///    * the list of all child frames.
    ///    */
    /// ```
    ///

    /// `void handleFrame (in mozIDOMWindowProxy frame, in unsigned long index);`
    #[inline]
    pub unsafe fn HandleFrame(&self, frame: *const mozIDOMWindowProxy, index: libc::uint32_t) -> nsresult {
        ((*self.vtable).HandleFrame)(self, frame, index)
    }


}


/// `interface nsISessionStoreUtils : nsISupports`
///

/// ```text
/// /**
///  * SessionStore utility functions implemented in C++ for performance reasons.
///  */
/// ```
///

// 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 nsISessionStoreUtils {
    vtable: *const nsISessionStoreUtilsVTable,

    /// 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 nsISessionStoreUtils.
unsafe impl XpCom for nsISessionStoreUtils {
    const IID: nsIID = nsID(0x2be448ef, 0xc783, 0x45de,
        [0xa0, 0xdf, 0x44, 0x2b, 0xcc, 0xbb, 0x45, 0x32]);
}

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

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

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

    /* void forEachNonDynamicChildFrame (in mozIDOMWindowProxy window, in nsISessionStoreUtilsFrameCallback callback); */
    pub ForEachNonDynamicChildFrame: unsafe extern "system" fn (this: *const nsISessionStoreUtils, window: *const mozIDOMWindowProxy, callback: *const nsISessionStoreUtilsFrameCallback) -> nsresult,

    /* nsIDOMEventListener createDynamicFrameEventFilter (in nsIDOMEventListener listener); */
    pub CreateDynamicFrameEventFilter: unsafe extern "system" fn (this: *const nsISessionStoreUtils, listener: *const nsIDOMEventListener, _retval: *mut *const nsIDOMEventListener) -> 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 nsISessionStoreUtils {

    /// ```text
    /// /**
    ///    * Calls the given |callback| once for each non-dynamic child frame of the
    ///    * given |window|.
    ///    */
    /// ```
    ///

    /// `void forEachNonDynamicChildFrame (in mozIDOMWindowProxy window, in nsISessionStoreUtilsFrameCallback callback);`
    #[inline]
    pub unsafe fn ForEachNonDynamicChildFrame(&self, window: *const mozIDOMWindowProxy, callback: *const nsISessionStoreUtilsFrameCallback) -> nsresult {
        ((*self.vtable).ForEachNonDynamicChildFrame)(self, window, callback)
    }


    /// ```text
    /// /**
    ///    * Creates and returns an event listener that filters events from dynamic
    ///    * docShells. It forwards those from non-dynamic docShells to the given
    ///    * |listener|.
    ///    *
    ///    * This is implemented as a native filter, rather than a JS-based one, for
    ///    * performance reasons.
    ///    */
    /// ```
    ///

    /// `nsIDOMEventListener createDynamicFrameEventFilter (in nsIDOMEventListener listener);`
    #[inline]
    pub unsafe fn CreateDynamicFrameEventFilter(&self, listener: *const nsIDOMEventListener, _retval: *mut *const nsIDOMEventListener) -> nsresult {
        ((*self.vtable).CreateDynamicFrameEventFilter)(self, listener, _retval)
    }


}