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


/// `interface nsIDOMStorageManager : nsISupports`
///

/// ```text
/// /**
///  * General purpose interface that has two implementations, for localStorage
///  * resp. sessionStorage with "@mozilla.org/dom/localStorage-manager;1" resp.
///  * "@mozilla.org/dom/sessionStorage-manager;1" contract IDs.
///  */
/// ```
///

// 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 nsIDOMStorageManager {
    vtable: *const nsIDOMStorageManagerVTable,

    /// 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 nsIDOMStorageManager.
unsafe impl XpCom for nsIDOMStorageManager {
    const IID: nsIID = nsID(0xa20c742e, 0x3ed1, 0x44fb,
        [0xb8, 0x97, 0x40, 0x80, 0xa7, 0x5b, 0x16, 0x62]);
}

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

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

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

    /* nsIDOMStorage precacheStorage (in nsIPrincipal aPrincipal); */
    pub PrecacheStorage: unsafe extern "system" fn (this: *const nsIDOMStorageManager, aPrincipal: *const nsIPrincipal, _retval: *mut *const nsIDOMStorage) -> nsresult,

    /* nsIDOMStorage createStorage (in mozIDOMWindow aWindow, in nsIPrincipal aPrincipal, in DOMString aDocumentURI, [optional] in bool aPrivate); */
    pub CreateStorage: unsafe extern "system" fn (this: *const nsIDOMStorageManager, aWindow: *const mozIDOMWindow, aPrincipal: *const nsIPrincipal, aDocumentURI: &::nsstring::nsAString, aPrivate: bool, _retval: *mut *const nsIDOMStorage) -> nsresult,

    /* nsIDOMStorage getStorage (in mozIDOMWindow aWindow, in nsIPrincipal aPrincipal, [optional] in bool aPrivate); */
    pub GetStorage: unsafe extern "system" fn (this: *const nsIDOMStorageManager, aWindow: *const mozIDOMWindow, aPrincipal: *const nsIPrincipal, aPrivate: bool, _retval: *mut *const nsIDOMStorage) -> nsresult,

    /* void cloneStorage (in nsIDOMStorage aStorageToCloneFrom); */
    pub CloneStorage: unsafe extern "system" fn (this: *const nsIDOMStorageManager, aStorageToCloneFrom: *const nsIDOMStorage) -> nsresult,

    /* bool checkStorage (in nsIPrincipal aPrincipal, in nsIDOMStorage aStorage); */
    pub CheckStorage: unsafe extern "system" fn (this: *const nsIDOMStorageManager, aPrincipal: *const nsIPrincipal, aStorage: *const nsIDOMStorage, _retval: *mut bool) -> 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 nsIDOMStorageManager {

    /// ```text
    /// /**
    ///    * This starts async preloading of a storage cache for scope
    ///    * defined by the principal.
    ///    *
    ///    * Because of how multi-e10s support was implemented in bug 1285898, the
    ///    * StorageCache instance can no longer use a timer to keep itself alive.  So a
    ///    * Storage instance is returned if precaching believes the principal may have
    ///    * localStorage data.  (Previously the StorageCache would be brought into
        ///    * existence and kept alive by the timer so that it could be returned if a
        ///    * call to createStorage was made due to a request by the page.)
    ///    */
    /// ```
    ///

    /// `nsIDOMStorage precacheStorage (in nsIPrincipal aPrincipal);`
    #[inline]
    pub unsafe fn PrecacheStorage(&self, aPrincipal: *const nsIPrincipal, _retval: *mut *const nsIDOMStorage) -> nsresult {
        ((*self.vtable).PrecacheStorage)(self, aPrincipal, _retval)
    }


    /// ```text
    /// /**
    ///    * Returns instance of DOM storage object for given principal.
    ///    * A new object is always returned and it is ensured there is
    ///    * a storage for the scope created.
    ///    *
    ///    * @param aWindow
    ///    *    The parent window.
    ///    * @param aPrincipal
    ///    *    Principal to bound storage to.
    ///    * @param aDocumentURI
    ///    *    URL of the demanding document, used for DOM storage event only.
    ///    * @param aPrivate
    ///    *    Whether the demanding document is running in Private Browsing mode or not.
    ///    */
    /// ```
    ///

    /// `nsIDOMStorage createStorage (in mozIDOMWindow aWindow, in nsIPrincipal aPrincipal, in DOMString aDocumentURI, [optional] in bool aPrivate);`
    #[inline]
    pub unsafe fn CreateStorage(&self, aWindow: *const mozIDOMWindow, aPrincipal: *const nsIPrincipal, aDocumentURI: &::nsstring::nsAString, aPrivate: bool, _retval: *mut *const nsIDOMStorage) -> nsresult {
        ((*self.vtable).CreateStorage)(self, aWindow, aPrincipal, aDocumentURI, aPrivate, _retval)
    }


    /// ```text
    /// /**
    ///    * Returns instance of DOM storage object for given principal.
    ///    * If there is no storage managed for the scope, then null is returned and
    ///    * no object is created.  Otherwise, an object (new) for the existing storage
    ///    * scope is returned.
    ///    *
    ///    * @param aWindow
    ///    *    The parent window.
    ///    * @param aPrincipal
    ///    *    Principal to bound storage to.
    ///    * @param aPrivate
    ///    *    Whether the demanding document is running in Private Browsing mode or not.
    ///    */
    /// ```
    ///

    /// `nsIDOMStorage getStorage (in mozIDOMWindow aWindow, in nsIPrincipal aPrincipal, [optional] in bool aPrivate);`
    #[inline]
    pub unsafe fn GetStorage(&self, aWindow: *const mozIDOMWindow, aPrincipal: *const nsIPrincipal, aPrivate: bool, _retval: *mut *const nsIDOMStorage) -> nsresult {
        ((*self.vtable).GetStorage)(self, aWindow, aPrincipal, aPrivate, _retval)
    }


    /// ```text
    /// /**
    ///    * Clones given storage into this storage manager.
    ///    *
    ///    * @param aStorageToCloneFrom
    ///    *    The storage to copy all items from into this manager.  Manager will then
    ///    *    return a new and independent object that contains snapshot of data from
    ///    *    the moment this method was called.  Modification to this new object will
    ///    *    not affect the original storage content we cloned from and vice versa.
    ///    */
    /// ```
    ///

    /// `void cloneStorage (in nsIDOMStorage aStorageToCloneFrom);`
    #[inline]
    pub unsafe fn CloneStorage(&self, aStorageToCloneFrom: *const nsIDOMStorage) -> nsresult {
        ((*self.vtable).CloneStorage)(self, aStorageToCloneFrom)
    }


    /// ```text
    /// /**
    ///    * Returns true if the storage belongs to the given principal and is managed
    ///    * (i.e. has been created and is cached) by this storage manager.
    ///    *
    ///    * @param aPrincipal
    ///    *    Principal to check the storage against.
    ///    * @param aStorage
    ///    *    The storage object to examine.
    ///    *
    ///    * @result
    ///    *    true when the storage object is bound with the principal and is managed
    ///    *         by this storage manager.
    ///    *    false otherwise
    ///    */
    /// ```
    ///

    /// `bool checkStorage (in nsIPrincipal aPrincipal, in nsIDOMStorage aStorage);`
    #[inline]
    pub unsafe fn CheckStorage(&self, aPrincipal: *const nsIPrincipal, aStorage: *const nsIDOMStorage, _retval: *mut bool) -> nsresult {
        ((*self.vtable).CheckStorage)(self, aPrincipal, aStorage, _retval)
    }


}