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


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

    /// 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 nsIDOMRange.
unsafe impl XpCom for nsIDOMRange {
    const IID: nsIID = nsID(0x1f94055c, 0x42e7, 0x4a30,
        [0x96, 0xa1, 0x6a, 0x80, 0x4f, 0x1c, 0x2d, 0x1e]);
}

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

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

impl nsIDOMRange {
    /// Cast this `nsIDOMRange` to one of its base interfaces.
    #[inline]
    pub fn coerce<T: nsIDOMRangeCoerce>(&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 nsIDOMRange {
    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> nsIDOMRangeCoerce for T {
    #[inline]
    fn coerce_from(v: &nsIDOMRange) -> &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 nsIDOMRange
// 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 nsIDOMRangeVTable {
    /// 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 startContainer; */
    pub GetStartContainer: unsafe extern "system" fn (this: *const nsIDOMRange, aStartContainer: *mut *const nsIDOMNode) -> nsresult,

    /* readonly attribute unsigned long startOffset; */
    pub GetStartOffset: unsafe extern "system" fn (this: *const nsIDOMRange, aStartOffset: *mut libc::uint32_t) -> nsresult,

    /* readonly attribute nsIDOMNode endContainer; */
    pub GetEndContainer: unsafe extern "system" fn (this: *const nsIDOMRange, aEndContainer: *mut *const nsIDOMNode) -> nsresult,

    /* readonly attribute unsigned long endOffset; */
    pub GetEndOffset: unsafe extern "system" fn (this: *const nsIDOMRange, aEndOffset: *mut libc::uint32_t) -> nsresult,

    /* readonly attribute boolean collapsed; */
    pub GetCollapsed: unsafe extern "system" fn (this: *const nsIDOMRange, aCollapsed: *mut bool) -> nsresult,

    /* readonly attribute nsIDOMNode commonAncestorContainer; */
    pub GetCommonAncestorContainer: unsafe extern "system" fn (this: *const nsIDOMRange, aCommonAncestorContainer: *mut *const nsIDOMNode) -> nsresult,

    /* void setStart (in nsIDOMNode refNode, in unsigned long offset); */
    pub SetStart: unsafe extern "system" fn (this: *const nsIDOMRange, refNode: *const nsIDOMNode, offset: libc::uint32_t) -> nsresult,

    /* void setEnd (in nsIDOMNode refNode, in unsigned long offset); */
    pub SetEnd: unsafe extern "system" fn (this: *const nsIDOMRange, refNode: *const nsIDOMNode, offset: libc::uint32_t) -> nsresult,

    /* void setStartBefore (in nsIDOMNode refNode); */
    pub SetStartBefore: unsafe extern "system" fn (this: *const nsIDOMRange, refNode: *const nsIDOMNode) -> nsresult,

    /* void setStartAfter (in nsIDOMNode refNode); */
    pub SetStartAfter: unsafe extern "system" fn (this: *const nsIDOMRange, refNode: *const nsIDOMNode) -> nsresult,

    /* void setEndBefore (in nsIDOMNode refNode); */
    pub SetEndBefore: unsafe extern "system" fn (this: *const nsIDOMRange, refNode: *const nsIDOMNode) -> nsresult,

    /* void setEndAfter (in nsIDOMNode refNode); */
    pub SetEndAfter: unsafe extern "system" fn (this: *const nsIDOMRange, refNode: *const nsIDOMNode) -> nsresult,

    /* void collapse (in boolean toStart); */
    pub Collapse: unsafe extern "system" fn (this: *const nsIDOMRange, toStart: bool) -> nsresult,

    /* void selectNode (in nsIDOMNode refNode); */
    pub SelectNode: unsafe extern "system" fn (this: *const nsIDOMRange, refNode: *const nsIDOMNode) -> nsresult,

    /* void selectNodeContents (in nsIDOMNode refNode); */
    pub SelectNodeContents: unsafe extern "system" fn (this: *const nsIDOMRange, refNode: *const nsIDOMNode) -> nsresult,

    /* short compareBoundaryPoints (in unsigned short how, in nsIDOMRange sourceRange); */
    pub CompareBoundaryPoints: unsafe extern "system" fn (this: *const nsIDOMRange, how: libc::uint16_t, sourceRange: *const nsIDOMRange, _retval: *mut libc::int16_t) -> nsresult,

    /* void deleteContents (); */
    pub DeleteContents: unsafe extern "system" fn (this: *const nsIDOMRange) -> nsresult,

    /* nsIDOMDocumentFragment extractContents (); */
    pub ExtractContents: unsafe extern "system" fn (this: *const nsIDOMRange, _retval: *mut *const nsIDOMDocumentFragment) -> nsresult,

    /* nsIDOMDocumentFragment cloneContents (); */
    pub CloneContents: unsafe extern "system" fn (this: *const nsIDOMRange, _retval: *mut *const nsIDOMDocumentFragment) -> nsresult,

    /* void insertNode (in nsIDOMNode newNode); */
    pub InsertNode: unsafe extern "system" fn (this: *const nsIDOMRange, newNode: *const nsIDOMNode) -> nsresult,

    /* void surroundContents (in nsIDOMNode newParent); */
    pub SurroundContents: unsafe extern "system" fn (this: *const nsIDOMRange, newParent: *const nsIDOMNode) -> nsresult,

    /* nsIDOMRange cloneRange (); */
    pub CloneRange: unsafe extern "system" fn (this: *const nsIDOMRange, _retval: *mut *const nsIDOMRange) -> nsresult,

    /* DOMString toString (); */
    pub ToString: unsafe extern "system" fn (this: *const nsIDOMRange, _retval: &mut ::nsstring::nsAString) -> nsresult,

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

    /* nsIDOMDocumentFragment createContextualFragment (in DOMString fragment); */
    pub CreateContextualFragment: unsafe extern "system" fn (this: *const nsIDOMRange, fragment: &::nsstring::nsAString, _retval: *mut *const nsIDOMDocumentFragment) -> nsresult,

    /* boolean isPointInRange (in nsIDOMNode parent, in unsigned long offset); */
    pub IsPointInRange: unsafe extern "system" fn (this: *const nsIDOMRange, parent: *const nsIDOMNode, offset: libc::uint32_t, _retval: *mut bool) -> nsresult,

    /* short comparePoint (in nsIDOMNode parent, in unsigned long offset); */
    pub ComparePoint: unsafe extern "system" fn (this: *const nsIDOMRange, parent: *const nsIDOMNode, offset: libc::uint32_t, _retval: *mut libc::int16_t) -> nsresult,

    /* boolean intersectsNode (in nsIDOMNode node); */
    pub IntersectsNode: unsafe extern "system" fn (this: *const nsIDOMRange, node: *const nsIDOMNode, _retval: *mut bool) -> nsresult,

    /* nsIDOMClientRectList getClientRects (); */
    pub GetClientRects: unsafe extern "system" fn (this: *const nsIDOMRange, _retval: *mut *const nsIDOMClientRectList) -> nsresult,

    /* nsIDOMClientRect getBoundingClientRect (); */
    pub GetBoundingClientRect: unsafe extern "system" fn (this: *const nsIDOMRange, _retval: *mut *const nsIDOMClientRect) -> 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 nsIDOMRange {

    pub const START_TO_START: i64 = 0;


    pub const START_TO_END: i64 = 1;


    pub const END_TO_END: i64 = 2;


    pub const END_TO_START: i64 = 3;

    /// ```text
    /// /**
    ///  * The nsIDOMRange interface is an interface to a DOM range object.
    ///  *
    ///  * For more information on this interface please see
    ///  * http://www.w3.org/TR/DOM-Level-2-Traversal-Range/
    ///  */
    /// ```
    ///

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



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



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



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



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



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



    /// `void setStart (in nsIDOMNode refNode, in unsigned long offset);`
    #[inline]
    pub unsafe fn SetStart(&self, refNode: *const nsIDOMNode, offset: libc::uint32_t) -> nsresult {
        ((*self.vtable).SetStart)(self, refNode, offset)
    }



    /// `void setEnd (in nsIDOMNode refNode, in unsigned long offset);`
    #[inline]
    pub unsafe fn SetEnd(&self, refNode: *const nsIDOMNode, offset: libc::uint32_t) -> nsresult {
        ((*self.vtable).SetEnd)(self, refNode, offset)
    }



    /// `void setStartBefore (in nsIDOMNode refNode);`
    #[inline]
    pub unsafe fn SetStartBefore(&self, refNode: *const nsIDOMNode) -> nsresult {
        ((*self.vtable).SetStartBefore)(self, refNode)
    }



    /// `void setStartAfter (in nsIDOMNode refNode);`
    #[inline]
    pub unsafe fn SetStartAfter(&self, refNode: *const nsIDOMNode) -> nsresult {
        ((*self.vtable).SetStartAfter)(self, refNode)
    }



    /// `void setEndBefore (in nsIDOMNode refNode);`
    #[inline]
    pub unsafe fn SetEndBefore(&self, refNode: *const nsIDOMNode) -> nsresult {
        ((*self.vtable).SetEndBefore)(self, refNode)
    }



    /// `void setEndAfter (in nsIDOMNode refNode);`
    #[inline]
    pub unsafe fn SetEndAfter(&self, refNode: *const nsIDOMNode) -> nsresult {
        ((*self.vtable).SetEndAfter)(self, refNode)
    }



    /// `void collapse (in boolean toStart);`
    #[inline]
    pub unsafe fn Collapse(&self, toStart: bool) -> nsresult {
        ((*self.vtable).Collapse)(self, toStart)
    }



    /// `void selectNode (in nsIDOMNode refNode);`
    #[inline]
    pub unsafe fn SelectNode(&self, refNode: *const nsIDOMNode) -> nsresult {
        ((*self.vtable).SelectNode)(self, refNode)
    }



    /// `void selectNodeContents (in nsIDOMNode refNode);`
    #[inline]
    pub unsafe fn SelectNodeContents(&self, refNode: *const nsIDOMNode) -> nsresult {
        ((*self.vtable).SelectNodeContents)(self, refNode)
    }



    /// `short compareBoundaryPoints (in unsigned short how, in nsIDOMRange sourceRange);`
    #[inline]
    pub unsafe fn CompareBoundaryPoints(&self, how: libc::uint16_t, sourceRange: *const nsIDOMRange, _retval: *mut libc::int16_t) -> nsresult {
        ((*self.vtable).CompareBoundaryPoints)(self, how, sourceRange, _retval)
    }



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



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



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



    /// `void insertNode (in nsIDOMNode newNode);`
    #[inline]
    pub unsafe fn InsertNode(&self, newNode: *const nsIDOMNode) -> nsresult {
        ((*self.vtable).InsertNode)(self, newNode)
    }



    /// `void surroundContents (in nsIDOMNode newParent);`
    #[inline]
    pub unsafe fn SurroundContents(&self, newParent: *const nsIDOMNode) -> nsresult {
        ((*self.vtable).SurroundContents)(self, newParent)
    }



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



    /// `DOMString toString ();`
    #[inline]
    pub unsafe fn ToString(&self, _retval: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).ToString)(self, _retval)
    }



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



    /// `nsIDOMDocumentFragment createContextualFragment (in DOMString fragment);`
    #[inline]
    pub unsafe fn CreateContextualFragment(&self, fragment: &::nsstring::nsAString, _retval: *mut *const nsIDOMDocumentFragment) -> nsresult {
        ((*self.vtable).CreateContextualFragment)(self, fragment, _retval)
    }



    /// `boolean isPointInRange (in nsIDOMNode parent, in unsigned long offset);`
    #[inline]
    pub unsafe fn IsPointInRange(&self, parent: *const nsIDOMNode, offset: libc::uint32_t, _retval: *mut bool) -> nsresult {
        ((*self.vtable).IsPointInRange)(self, parent, offset, _retval)
    }



    /// `short comparePoint (in nsIDOMNode parent, in unsigned long offset);`
    #[inline]
    pub unsafe fn ComparePoint(&self, parent: *const nsIDOMNode, offset: libc::uint32_t, _retval: *mut libc::int16_t) -> nsresult {
        ((*self.vtable).ComparePoint)(self, parent, offset, _retval)
    }


    /// ```text
    /// /**
    ///    * Returns whether the range intersects node.
    ///    */
    /// ```
    ///

    /// `boolean intersectsNode (in nsIDOMNode node);`
    #[inline]
    pub unsafe fn IntersectsNode(&self, node: *const nsIDOMNode, _retval: *mut bool) -> nsresult {
        ((*self.vtable).IntersectsNode)(self, node, _retval)
    }



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



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


}