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


/// `interface nsPIPlacesDatabase : nsISupports`
///

/// ```text
/// /**
///  * This is a private interface used by Places components to get access to the
///  * database.  If outside consumers wish to use this, they should only read from
///  * the database so they do not break any internal invariants.
///  */
/// ```
///

// 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 nsPIPlacesDatabase {
    vtable: *const nsPIPlacesDatabaseVTable,

    /// 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 nsPIPlacesDatabase.
unsafe impl XpCom for nsPIPlacesDatabase {
    const IID: nsIID = nsID(0x366ee63e, 0xa413, 0x477d,
        [0x9a, 0xd6, 0x8d, 0x68, 0x63, 0xe8, 0x94, 0x01]);
}

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

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

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

    /* readonly attribute mozIStorageConnection DBConnection; */
    pub GetDBConnection: unsafe extern "system" fn (this: *const nsPIPlacesDatabase, aDBConnection: *mut *const mozIStorageConnection) -> nsresult,

    /* mozIStoragePendingStatement asyncExecuteLegacyQueries ([array, size_is (aQueryCount)] in nsINavHistoryQuery aQueries, in unsigned long aQueryCount, in nsINavHistoryQueryOptions aOptions, in mozIStorageStatementCallback aCallback); */
    pub AsyncExecuteLegacyQueries: unsafe extern "system" fn (this: *const nsPIPlacesDatabase, aQueries: *mut *const nsINavHistoryQuery, aQueryCount: libc::uint32_t, aOptions: *const nsINavHistoryQueryOptions, aCallback: *const mozIStorageStatementCallback, _retval: *mut *const mozIStoragePendingStatement) -> nsresult,

    /* readonly attribute nsIAsyncShutdownClient shutdownClient; */
    pub GetShutdownClient: unsafe extern "system" fn (this: *const nsPIPlacesDatabase, aShutdownClient: *mut *const nsIAsyncShutdownClient) -> nsresult,

    /* readonly attribute nsIAsyncShutdownClient connectionShutdownClient; */
    pub GetConnectionShutdownClient: unsafe extern "system" fn (this: *const nsPIPlacesDatabase, aConnectionShutdownClient: *mut *const nsIAsyncShutdownClient) -> 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 nsPIPlacesDatabase {

    /// ```text
    /// /**
    ///    * The database connection used by Places.
    ///    */
    /// ```
    ///

    /// `readonly attribute mozIStorageConnection DBConnection;`
    #[inline]
    pub unsafe fn GetDBConnection(&self, aDBConnection: *mut *const mozIStorageConnection) -> nsresult {
        ((*self.vtable).GetDBConnection)(self, aDBConnection)
    }


    /// ```text
    /// /**
    ///    * Asynchronously executes the statement created from queries.
    ///    *
    ///    * @see nsINavHistoryService::executeQueries
    ///    * @note THIS IS A TEMPORARY API.  Don't rely on it, since it will be replaced
    ///    *       in future versions by a real async querying API.
    ///    * @note Results obtained from this method differ from results obtained from
    ///    *       executeQueries, because there is additional filtering and sorting
    ///    *       done by the latter.  Thus you should use executeQueries, unless you
    ///    *       are absolutely sure that the returned results are fine for
    ///    *       your use-case.
    ///    */
    /// ```
    ///

    /// `mozIStoragePendingStatement asyncExecuteLegacyQueries ([array, size_is (aQueryCount)] in nsINavHistoryQuery aQueries, in unsigned long aQueryCount, in nsINavHistoryQueryOptions aOptions, in mozIStorageStatementCallback aCallback);`
    #[inline]
    pub unsafe fn AsyncExecuteLegacyQueries(&self, aQueries: *mut *const nsINavHistoryQuery, aQueryCount: libc::uint32_t, aOptions: *const nsINavHistoryQueryOptions, aCallback: *const mozIStorageStatementCallback, _retval: *mut *const mozIStoragePendingStatement) -> nsresult {
        ((*self.vtable).AsyncExecuteLegacyQueries)(self, aQueries, aQueryCount, aOptions, aCallback, _retval)
    }


    /// ```text
    /// /**
    ///    * Hook for clients who need to perform actions during/by the end of
    ///    * the shutdown of the database.
    ///    * May be null if it's too late to get one.
    ///    */
    /// ```
    ///

    /// `readonly attribute nsIAsyncShutdownClient shutdownClient;`
    #[inline]
    pub unsafe fn GetShutdownClient(&self, aShutdownClient: *mut *const nsIAsyncShutdownClient) -> nsresult {
        ((*self.vtable).GetShutdownClient)(self, aShutdownClient)
    }


    /// ```text
    /// /**
    ///    * Hook for internal clients who need to perform actions just before the
    ///    * connection gets closed.
    ///    * May be null if it's too late to get one.
    ///    */
    /// ```
    ///

    /// `readonly attribute nsIAsyncShutdownClient connectionShutdownClient;`
    #[inline]
    pub unsafe fn GetConnectionShutdownClient(&self, aConnectionShutdownClient: *mut *const nsIAsyncShutdownClient) -> nsresult {
        ((*self.vtable).GetConnectionShutdownClient)(self, aConnectionShutdownClient)
    }


}