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


/// `interface nsIAddonInterposition : nsISupports`
///

/// ```text
/// /**
///  * This interface allows Firefox to expose different implementations of its own
///  * classes to add-ons. Once an interposition is created, it must be assigned to
///  * an add-on using Cu.setAddonInterposition (JS) or xpc::SetAddonInterposition
///  * (C++). In both cases, the arguments should be the add-on ID and the
///  * interposition object (which must be an nsIAddonInterposition). This must
///  * happen before any compartments are created for the given add-on.
///  *
///  * Every time the add-on accesses a property on any object outside its own set
///  * of compartments, XPConnect will call the interposition's
///  * interpose method. If the interposition wants to replace the given
///  * property, it should return a replacement property descriptor for it. If not,
///  * it should return null.
///  */
/// ```
///

// 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 nsIAddonInterposition {
    vtable: *const nsIAddonInterpositionVTable,

    /// 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 nsIAddonInterposition.
unsafe impl XpCom for nsIAddonInterposition {
    const IID: nsIID = nsID(0xd05cc5fd, 0xad88, 0x41a6,
        [0x85, 0x4c, 0x36, 0xfd, 0x94, 0xd6, 0x9d, 0xdb]);
}

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

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

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

    /* jsval interposeProperty (in jsval addonId, in jsval target, in nsIIDPtr iface, in jsval prop); */
    /// Unable to generate binding because `native type JS::Value is unsupported`
    pub InterposeProperty: *const ::libc::c_void,

    /* jsval interposeCall (in jsval addonId, in jsval originalFunc, in jsval originalThis, in jsval args); */
    /// Unable to generate binding because `native type JS::Value is unsupported`
    pub InterposeCall: *const ::libc::c_void,

    /* jsval getWhitelist (); */
    /// Unable to generate binding because `native type JS::Value is unsupported`
    pub GetWhitelist: *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 nsIAddonInterposition {

    /// ```text
    /// /**
    ///      * Returns a replacement property descriptor for a browser object.
    ///      *
    ///      * @param addonId The ID of the add-on accessing the property.
    ///      * @param target The browser object being accessed.
    ///      * @param iface The IID of the interface the property is associated with. This
    ///      *              parameter is only available for XPCWrappedNative targets. As
    ///      *              such, it's only useful as an optimization to avoid
    ///      *              instanceof checks on the target.
    ///      * @param prop The name of the property being accessed.
    ///      * @return A property descriptor or null.
    ///      */
    /// ```
    ///

    /// `jsval interposeProperty (in jsval addonId, in jsval target, in nsIIDPtr iface, in jsval prop);`
    const _InterposeProperty: () = ();

    /// ```text
    /// /**
    ///      * We're intercepting calls from add-ons scopes into non-addon scopes.
    ///      *
    ///      * @param addonId The ID of the add-on accessing the property.
    ///      * @param originalFunc The function object being intercepted.
    ///      * @param originalThis The |this| value for the intercepted call.
    ///      * @param args The arguments of the original call in an array.
    ///      * @return The result of the call. NOTE: after the call interception,
    ///      * the original function will not be called automatically, so the
    ///      * implementer has to do that.
    ///      */
    /// ```
    ///

    /// `jsval interposeCall (in jsval addonId, in jsval originalFunc, in jsval originalThis, in jsval args);`
    const _InterposeCall: () = ();

    /// ```text
    /// /**
    ///      * For the first time when the interposition is registered the engine
    ///      * calls getWhitelist and expects an array of strings. The strings are
    ///      * the name of properties the interposition wants interposeProperty
    ///      * to be called. It can be an empty array.
    ///      * Note: for CPOWs interposeProperty is always called regardless if
    ///      * the name of the property is on the whitelist or not.
    ///      */
    /// ```
    ///

    /// `jsval getWhitelist ();`
    const _GetWhitelist: () = ();

}