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


/// `interface nsIDOMNodeIterator : nsISupports`
///


// 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 nsIDOMNodeIterator {
    vtable: *const nsIDOMNodeIteratorVTable,

    /// 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 nsIDOMNodeIterator.
unsafe impl XpCom for nsIDOMNodeIterator {
    const IID: nsIID = nsID(0xa86bdac9, 0xff89, 0x4c94,
        [0x81, 0x60, 0x4f, 0xe8, 0x67, 0x33, 0xba, 0xb8]);
}

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

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

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

    /* readonly attribute nsIDOMNode root; */
    pub GetRoot: unsafe extern "system" fn (this: *const nsIDOMNodeIterator, aRoot: *mut *const nsIDOMNode) -> nsresult,

    /* readonly attribute unsigned long whatToShow; */
    pub GetWhatToShow: unsafe extern "system" fn (this: *const nsIDOMNodeIterator, aWhatToShow: *mut libc::uint32_t) -> nsresult,

    /* readonly attribute nsIDOMNodeFilter filter; */
    pub GetFilter: unsafe extern "system" fn (this: *const nsIDOMNodeIterator, aFilter: *mut *const nsIDOMNodeFilter) -> nsresult,

    /* nsIDOMNode nextNode () raises (DOMException); */
    pub NextNode: unsafe extern "system" fn (this: *const nsIDOMNodeIterator, _retval: *mut *const nsIDOMNode) -> nsresult,

    /* nsIDOMNode previousNode () raises (DOMException); */
    pub PreviousNode: unsafe extern "system" fn (this: *const nsIDOMNodeIterator, _retval: *mut *const nsIDOMNode) -> nsresult,

    /* void detach (); */
    pub Detach: unsafe extern "system" fn (this: *const nsIDOMNodeIterator) -> nsresult,

    /* readonly attribute nsIDOMNode referenceNode; */
    pub GetReferenceNode: unsafe extern "system" fn (this: *const nsIDOMNodeIterator, aReferenceNode: *mut *const nsIDOMNode) -> nsresult,

    /* readonly attribute boolean pointerBeforeReferenceNode; */
    pub GetPointerBeforeReferenceNode: unsafe extern "system" fn (this: *const nsIDOMNodeIterator, aPointerBeforeReferenceNode: *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 nsIDOMNodeIterator {


    /// `readonly attribute nsIDOMNode root;`
    #[inline]
    pub unsafe fn GetRoot(&self, aRoot: *mut *const nsIDOMNode) -> nsresult {
        ((*self.vtable).GetRoot)(self, aRoot)
    }



    /// `readonly attribute unsigned long whatToShow;`
    #[inline]
    pub unsafe fn GetWhatToShow(&self, aWhatToShow: *mut libc::uint32_t) -> nsresult {
        ((*self.vtable).GetWhatToShow)(self, aWhatToShow)
    }



    /// `readonly attribute nsIDOMNodeFilter filter;`
    #[inline]
    pub unsafe fn GetFilter(&self, aFilter: *mut *const nsIDOMNodeFilter) -> nsresult {
        ((*self.vtable).GetFilter)(self, aFilter)
    }



    /// `nsIDOMNode nextNode () raises (DOMException);`
    #[inline]
    pub unsafe fn NextNode(&self, _retval: *mut *const nsIDOMNode) -> nsresult {
        ((*self.vtable).NextNode)(self, _retval)
    }



    /// `nsIDOMNode previousNode () raises (DOMException);`
    #[inline]
    pub unsafe fn PreviousNode(&self, _retval: *mut *const nsIDOMNode) -> nsresult {
        ((*self.vtable).PreviousNode)(self, _retval)
    }



    /// `void detach ();`
    #[inline]
    pub unsafe fn Detach(&self, ) -> nsresult {
        ((*self.vtable).Detach)(self, )
    }



    /// `readonly attribute nsIDOMNode referenceNode;`
    #[inline]
    pub unsafe fn GetReferenceNode(&self, aReferenceNode: *mut *const nsIDOMNode) -> nsresult {
        ((*self.vtable).GetReferenceNode)(self, aReferenceNode)
    }



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


}