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


/// `interface nsIDOMSerializer : nsISupports`
///

/// ```text
/// /**
///  * The nsIDOMSerializer interface is really a placeholder till the W3C
///  * DOM Working Group defines a mechanism for serializing DOM nodes.
///  * An instance of this interface can be used to serialize a DOM document
///  * or any DOM subtree.
///  */
/// ```
///

// 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 nsIDOMSerializer {
    vtable: *const nsIDOMSerializerVTable,

    /// 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 nsIDOMSerializer.
unsafe impl XpCom for nsIDOMSerializer {
    const IID: nsIID = nsID(0x9fd4ba15, 0xe67c, 0x4c98,
        [0xb5, 0x2c, 0x77, 0x15, 0xf6, 0x2c, 0x91, 0x96]);
}

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

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

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

    /* AString serializeToString (in nsIDOMNode root); */
    pub SerializeToString: unsafe extern "system" fn (this: *const nsIDOMSerializer, root: *const nsIDOMNode, _retval: &mut ::nsstring::nsAString) -> nsresult,

    /* void serializeToStream (in nsIDOMNode root, in nsIOutputStream stream, in AUTF8String charset); */
    pub SerializeToStream: unsafe extern "system" fn (this: *const nsIDOMSerializer, root: *const nsIDOMNode, stream: *const nsIOutputStream, charset: &::nsstring::nsACString) -> 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 nsIDOMSerializer {

    /// ```text
    /// /**
    ///    * The subtree rooted by the specified element is serialized to
    ///    * a string.
    ///    *
    ///    * @param root The root of the subtree to be serialized. This could
    ///    *             be any node, including a Document.
    ///    * @returns The serialized subtree in the form of a Unicode string
    ///    */
    /// ```
    ///

    /// `AString serializeToString (in nsIDOMNode root);`
    #[inline]
    pub unsafe fn SerializeToString(&self, root: *const nsIDOMNode, _retval: &mut ::nsstring::nsAString) -> nsresult {
        ((*self.vtable).SerializeToString)(self, root, _retval)
    }


    /// ```text
    /// /**
    ///    * The subtree rooted by the specified element is serialized to
    ///    * a byte stream using the character set specified.
    ///    * @param root The root of the subtree to be serialized. This could
    ///    *             be any node, including a Document.
    ///    * @param stream The byte stream to which the subtree is serialized.
    ///    * @param charset The name of the character set to use for the encoding
    ///    *                to a byte stream.  If this string is empty and root is
    ///    *                a document, the document's character set will be used.
    ///    */
    /// ```
    ///

    /// `void serializeToStream (in nsIDOMNode root, in nsIOutputStream stream, in AUTF8String charset);`
    #[inline]
    pub unsafe fn SerializeToStream(&self, root: *const nsIDOMNode, stream: *const nsIOutputStream, charset: &::nsstring::nsACString) -> nsresult {
        ((*self.vtable).SerializeToStream)(self, root, stream, charset)
    }


}