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


/// `interface nsIDOMTreeWalker : 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 nsIDOMTreeWalker {
    vtable: *const nsIDOMTreeWalkerVTable,

    /// 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 nsIDOMTreeWalker.
unsafe impl XpCom for nsIDOMTreeWalker {
    const IID: nsIID = nsID(0xc4ffa159, 0x237c, 0x4dde,
        [0xb0, 0xba, 0x20, 0xb9, 0xf9, 0x27, 0x0c, 0xf6]);
}

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

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

impl nsIDOMTreeWalker {
    /// Cast this `nsIDOMTreeWalker` to one of its base interfaces.
    #[inline]
    pub fn coerce<T: nsIDOMTreeWalkerCoerce>(&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 nsIDOMTreeWalker {
    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> nsIDOMTreeWalkerCoerce for T {
    #[inline]
    fn coerce_from(v: &nsIDOMTreeWalker) -> &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 nsIDOMTreeWalker
// 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 nsIDOMTreeWalkerVTable {
    /// 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 nsIDOMTreeWalker, aRoot: *mut *const nsIDOMNode) -> nsresult,

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

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

    /* attribute nsIDOMNode currentNode; */
    pub GetCurrentNode: unsafe extern "system" fn (this: *const nsIDOMTreeWalker, aCurrentNode: *mut *const nsIDOMNode) -> nsresult,

    /* attribute nsIDOMNode currentNode; */
    pub SetCurrentNode: unsafe extern "system" fn (this: *const nsIDOMTreeWalker, aCurrentNode: *const nsIDOMNode) -> nsresult,

    /* nsIDOMNode parentNode (); */
    pub ParentNode: unsafe extern "system" fn (this: *const nsIDOMTreeWalker, _retval: *mut *const nsIDOMNode) -> nsresult,

    /* nsIDOMNode firstChild (); */
    pub FirstChild: unsafe extern "system" fn (this: *const nsIDOMTreeWalker, _retval: *mut *const nsIDOMNode) -> nsresult,

    /* nsIDOMNode lastChild (); */
    pub LastChild: unsafe extern "system" fn (this: *const nsIDOMTreeWalker, _retval: *mut *const nsIDOMNode) -> nsresult,

    /* nsIDOMNode previousSibling (); */
    pub PreviousSibling: unsafe extern "system" fn (this: *const nsIDOMTreeWalker, _retval: *mut *const nsIDOMNode) -> nsresult,

    /* nsIDOMNode nextSibling (); */
    pub NextSibling: unsafe extern "system" fn (this: *const nsIDOMTreeWalker, _retval: *mut *const nsIDOMNode) -> nsresult,

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

    /* nsIDOMNode nextNode (); */
    pub NextNode: unsafe extern "system" fn (this: *const nsIDOMTreeWalker, _retval: *mut *const nsIDOMNode) -> 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 nsIDOMTreeWalker {


    /// `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)
    }



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



    /// `attribute nsIDOMNode currentNode;`
    #[inline]
    pub unsafe fn SetCurrentNode(&self, aCurrentNode: *const nsIDOMNode) -> nsresult {
        ((*self.vtable).SetCurrentNode)(self, aCurrentNode)
    }



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



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



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



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



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



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



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


}