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


/// `interface nsIRDFCompositeDataSource : nsIRDFDataSource`
///

/// ```text
/// /**
///  * An nsIRDFCompositeDataSource composes individual data sources, providing
///  * the illusion of a single, coherent RDF graph.
///  */
/// ```
///

// 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 nsIRDFCompositeDataSource {
    vtable: *const nsIRDFCompositeDataSourceVTable,

    /// 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 nsIRDFCompositeDataSource.
unsafe impl XpCom for nsIRDFCompositeDataSource {
    const IID: nsIID = nsID(0x96343820, 0x307c, 0x11d2,
        [0xbc, 0x15, 0x00, 0x80, 0x5f, 0x91, 0x2f, 0xe7]);
}

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

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

impl nsIRDFCompositeDataSource {
    /// Cast this `nsIRDFCompositeDataSource` to one of its base interfaces.
    #[inline]
    pub fn coerce<T: nsIRDFCompositeDataSourceCoerce>(&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 nsIRDFCompositeDataSource {
    type Target = nsIRDFDataSource;
    #[inline]
    fn deref(&self) -> &nsIRDFDataSource {
        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: nsIRDFDataSourceCoerce> nsIRDFCompositeDataSourceCoerce for T {
    #[inline]
    fn coerce_from(v: &nsIRDFCompositeDataSource) -> &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 nsIRDFCompositeDataSource
// 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 nsIRDFCompositeDataSourceVTable {
    /// We need to include the members from the base interface's vtable at the start
    /// of the VTable definition.
    pub __base: nsIRDFDataSourceVTable,

    /* attribute boolean allowNegativeAssertions; */
    pub GetAllowNegativeAssertions: unsafe extern "system" fn (this: *const nsIRDFCompositeDataSource, aAllowNegativeAssertions: *mut bool) -> nsresult,

    /* attribute boolean allowNegativeAssertions; */
    pub SetAllowNegativeAssertions: unsafe extern "system" fn (this: *const nsIRDFCompositeDataSource, aAllowNegativeAssertions: bool) -> nsresult,

    /* attribute boolean coalesceDuplicateArcs; */
    pub GetCoalesceDuplicateArcs: unsafe extern "system" fn (this: *const nsIRDFCompositeDataSource, aCoalesceDuplicateArcs: *mut bool) -> nsresult,

    /* attribute boolean coalesceDuplicateArcs; */
    pub SetCoalesceDuplicateArcs: unsafe extern "system" fn (this: *const nsIRDFCompositeDataSource, aCoalesceDuplicateArcs: bool) -> nsresult,

    /* void AddDataSource (in nsIRDFDataSource aDataSource); */
    pub AddDataSource: unsafe extern "system" fn (this: *const nsIRDFCompositeDataSource, aDataSource: *const nsIRDFDataSource) -> nsresult,

    /* void RemoveDataSource (in nsIRDFDataSource aDataSource); */
    pub RemoveDataSource: unsafe extern "system" fn (this: *const nsIRDFCompositeDataSource, aDataSource: *const nsIRDFDataSource) -> nsresult,

    /* nsISimpleEnumerator GetDataSources (); */
    pub GetDataSources: unsafe extern "system" fn (this: *const nsIRDFCompositeDataSource, _retval: *mut *const nsISimpleEnumerator) -> 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 nsIRDFCompositeDataSource {

    /// ```text
    /// /**
    ///      *
    ///      * Set this value to <code>true</code> if the composite datasource
    ///      * may contains at least one datasource that has <em>negative</em>
    ///      * assertions. (This is the default.)
    ///      *
    ///      * Set this value to <code>false</code> if none of the datasources
    ///      * being composed contains a negative assertion. This allows the
    ///      * composite datasource to perform some query optimizations.
    ///      *
    ///      * By default, this value is <code>true</true>.
    ///      */
    /// ```
    ///

    /// `attribute boolean allowNegativeAssertions;`
    #[inline]
    pub unsafe fn GetAllowNegativeAssertions(&self, aAllowNegativeAssertions: *mut bool) -> nsresult {
        ((*self.vtable).GetAllowNegativeAssertions)(self, aAllowNegativeAssertions)
    }


    /// ```text
    /// /**
    ///      *
    ///      * Set this value to <code>true</code> if the composite datasource
    ///      * may contains at least one datasource that has <em>negative</em>
    ///      * assertions. (This is the default.)
    ///      *
    ///      * Set this value to <code>false</code> if none of the datasources
    ///      * being composed contains a negative assertion. This allows the
    ///      * composite datasource to perform some query optimizations.
    ///      *
    ///      * By default, this value is <code>true</true>.
    ///      */
    /// ```
    ///

    /// `attribute boolean allowNegativeAssertions;`
    #[inline]
    pub unsafe fn SetAllowNegativeAssertions(&self, aAllowNegativeAssertions: bool) -> nsresult {
        ((*self.vtable).SetAllowNegativeAssertions)(self, aAllowNegativeAssertions)
    }


    /// ```text
    /// /**
    ///      * Set to <code>true</code> if the composite datasource should
    ///      * take care to coalesce duplicate arcs when returning values from
    ///      * queries. (This is the default.)
    ///      *
    ///      * Set to <code>false</code> if the composite datasource shouldn't
    ///      * bother to check for duplicates. This allows the composite
    ///      * datasource to more efficiently answer queries.
    ///      *
    ///      * By default, this value is <code>true</code>.
    ///      */
    /// ```
    ///

    /// `attribute boolean coalesceDuplicateArcs;`
    #[inline]
    pub unsafe fn GetCoalesceDuplicateArcs(&self, aCoalesceDuplicateArcs: *mut bool) -> nsresult {
        ((*self.vtable).GetCoalesceDuplicateArcs)(self, aCoalesceDuplicateArcs)
    }


    /// ```text
    /// /**
    ///      * Set to <code>true</code> if the composite datasource should
    ///      * take care to coalesce duplicate arcs when returning values from
    ///      * queries. (This is the default.)
    ///      *
    ///      * Set to <code>false</code> if the composite datasource shouldn't
    ///      * bother to check for duplicates. This allows the composite
    ///      * datasource to more efficiently answer queries.
    ///      *
    ///      * By default, this value is <code>true</code>.
    ///      */
    /// ```
    ///

    /// `attribute boolean coalesceDuplicateArcs;`
    #[inline]
    pub unsafe fn SetCoalesceDuplicateArcs(&self, aCoalesceDuplicateArcs: bool) -> nsresult {
        ((*self.vtable).SetCoalesceDuplicateArcs)(self, aCoalesceDuplicateArcs)
    }


    /// ```text
    /// /**
    ///      * Add a datasource the the composite data source.
    ///      * @param aDataSource the datasource to add to composite
    ///      */
    /// ```
    ///

    /// `void AddDataSource (in nsIRDFDataSource aDataSource);`
    #[inline]
    pub unsafe fn AddDataSource(&self, aDataSource: *const nsIRDFDataSource) -> nsresult {
        ((*self.vtable).AddDataSource)(self, aDataSource)
    }


    /// ```text
    /// /**
    ///      * Remove a datasource from the composite data source.
    ///      * @param aDataSource the datasource to remove from the composite
    ///      */
    /// ```
    ///

    /// `void RemoveDataSource (in nsIRDFDataSource aDataSource);`
    #[inline]
    pub unsafe fn RemoveDataSource(&self, aDataSource: *const nsIRDFDataSource) -> nsresult {
        ((*self.vtable).RemoveDataSource)(self, aDataSource)
    }


    /// ```text
    /// /**
    ///      * Retrieve the datasources in the composite data source.
    ///      * @return an nsISimpleEnumerator that will enumerate each
    ///      * of the datasources in the composite
    ///      */
    /// ```
    ///

    /// `nsISimpleEnumerator GetDataSources ();`
    #[inline]
    pub unsafe fn GetDataSources(&self, _retval: *mut *const nsISimpleEnumerator) -> nsresult {
        ((*self.vtable).GetDataSources)(self, _retval)
    }


}