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


/// `interface nsIURIRefObject : nsISupports`
///

/// ```text
/// /** A class which can represent any node which points to an
///   * external URI, e.g. <a>, <img>, <script> etc,
///   * and has the capability to rewrite URLs to be
///   * relative or absolute.
///   * Used by the editor but not dependant on it.
///   */
/// ```
///

// 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 nsIURIRefObject {
    vtable: *const nsIURIRefObjectVTable,

    /// 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 nsIURIRefObject.
unsafe impl XpCom for nsIURIRefObject {
    const IID: nsIID = nsID(0x2226927e, 0x1dd2, 0x11b2,
        [0xb5, 0x7f, 0xfa, 0xab, 0x47, 0x28, 0x85, 0x63]);
}

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

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

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

    /* attribute nsIDOMNode node; */
    pub GetNode: unsafe extern "system" fn (this: *const nsIURIRefObject, aNode: *mut *const nsIDOMNode) -> nsresult,

    /* attribute nsIDOMNode node; */
    pub SetNode: unsafe extern "system" fn (this: *const nsIURIRefObject, aNode: *const nsIDOMNode) -> nsresult,

    /* void Reset (); */
    pub Reset: unsafe extern "system" fn (this: *const nsIURIRefObject) -> nsresult,

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

    /* void RewriteAllURIs (in DOMString aOldPat, in DOMString aNewPat, in boolean aMakeRel); */
    pub RewriteAllURIs: unsafe extern "system" fn (this: *const nsIURIRefObject, aOldPat: &::nsstring::nsAString, aNewPat: &::nsstring::nsAString, aMakeRel: 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 nsIURIRefObject {


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



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


    /// ```text
    /// /**
    ///    * Go back to the beginning of the attribute list.
    ///    */
    /// ```
    ///

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


    /// ```text
    /// /**
    ///    * Return the next rewritable URI.
    ///    */
    /// ```
    ///

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


    /// ```text
    /// /**
    ///    * Go back to the beginning of the attribute list
    ///    *
    ///    * @param aOldPat  Old pattern to be replaced, e.g. file:///a/b/
    ///    * @param aNewPat  New pattern to be replaced, e.g. http://mypage.aol.com/
    ///    * @param aMakeRel Rewrite links as relative vs. absolute
    ///    */
    /// ```
    ///

    /// `void RewriteAllURIs (in DOMString aOldPat, in DOMString aNewPat, in boolean aMakeRel);`
    #[inline]
    pub unsafe fn RewriteAllURIs(&self, aOldPat: &::nsstring::nsAString, aNewPat: &::nsstring::nsAString, aMakeRel: bool) -> nsresult {
        ((*self.vtable).RewriteAllURIs)(self, aOldPat, aNewPat, aMakeRel)
    }


}