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


/// `interface nsISAXXMLReader : nsIStreamListener`
///

/// ```text
/// /**
///  * Interface for reading an XML document using callbacks.
///  *
///  * NOTE: This file (and related ones) used to implement a full-featured SAX XML
///  * parser. But we have few uses of this interface and the ones we have only use
///  * a fraction of the full SAX functionality. So in bug 1416038 we removed a lot
///  * of it. See the changes associated with that bug if you need to reintroduce
///  * any of that functionality.
///  *
///  * nsISAXXMLReader is the interface that an XML parser's SAX2
///  * driver must implement.  This interface allows an application to set
///  * and query features and properties in the parser, to register event
///  * handlers for document processing, and to initiate a document
///  * parse.
///  */
/// ```
///

// 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 nsISAXXMLReader {
    vtable: *const nsISAXXMLReaderVTable,

    /// 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 nsISAXXMLReader.
unsafe impl XpCom for nsISAXXMLReader {
    const IID: nsIID = nsID(0x5b1de802, 0x9091, 0x454f,
        [0x99, 0x72, 0x57, 0x53, 0xc0, 0xd0, 0xc7, 0x0e]);
}

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

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

impl nsISAXXMLReader {
    /// Cast this `nsISAXXMLReader` to one of its base interfaces.
    #[inline]
    pub fn coerce<T: nsISAXXMLReaderCoerce>(&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 nsISAXXMLReader {
    type Target = nsIStreamListener;
    #[inline]
    fn deref(&self) -> &nsIStreamListener {
        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: nsIStreamListenerCoerce> nsISAXXMLReaderCoerce for T {
    #[inline]
    fn coerce_from(v: &nsISAXXMLReader) -> &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 nsISAXXMLReader
// 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 nsISAXXMLReaderVTable {
    /// We need to include the members from the base interface's vtable at the start
    /// of the VTable definition.
    pub __base: nsIStreamListenerVTable,

    /* attribute nsIURI baseURI; */
    pub GetBaseURI: unsafe extern "system" fn (this: *const nsISAXXMLReader, aBaseURI: *mut *const nsIURI) -> nsresult,

    /* attribute nsIURI baseURI; */
    pub SetBaseURI: unsafe extern "system" fn (this: *const nsISAXXMLReader, aBaseURI: *const nsIURI) -> nsresult,

    /* attribute nsISAXContentHandler contentHandler; */
    pub GetContentHandler: unsafe extern "system" fn (this: *const nsISAXXMLReader, aContentHandler: *mut *const nsISAXContentHandler) -> nsresult,

    /* attribute nsISAXContentHandler contentHandler; */
    pub SetContentHandler: unsafe extern "system" fn (this: *const nsISAXXMLReader, aContentHandler: *const nsISAXContentHandler) -> nsresult,

    /* attribute nsISAXErrorHandler errorHandler; */
    pub GetErrorHandler: unsafe extern "system" fn (this: *const nsISAXXMLReader, aErrorHandler: *mut *const nsISAXErrorHandler) -> nsresult,

    /* attribute nsISAXErrorHandler errorHandler; */
    pub SetErrorHandler: unsafe extern "system" fn (this: *const nsISAXXMLReader, aErrorHandler: *const nsISAXErrorHandler) -> nsresult,

    /* void parseFromString (in AString str, in string contentType); */
    pub ParseFromString: unsafe extern "system" fn (this: *const nsISAXXMLReader, str: &::nsstring::nsAString, contentType: *const libc::c_char) -> nsresult,

    /* void parseFromStream (in nsIInputStream stream, in string charset, in string contentType); */
    pub ParseFromStream: unsafe extern "system" fn (this: *const nsISAXXMLReader, stream: *const nsIInputStream, charset: *const libc::c_char, contentType: *const libc::c_char) -> nsresult,

    /* void parseAsync (in nsIRequestObserver observer); */
    pub ParseAsync: unsafe extern "system" fn (this: *const nsISAXXMLReader, observer: *const nsIRequestObserver) -> 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 nsISAXXMLReader {

    /// ```text
    /// /**
    ///    * The base URI.
    ///    */
    /// ```
    ///

    /// `attribute nsIURI baseURI;`
    #[inline]
    pub unsafe fn GetBaseURI(&self, aBaseURI: *mut *const nsIURI) -> nsresult {
        ((*self.vtable).GetBaseURI)(self, aBaseURI)
    }


    /// ```text
    /// /**
    ///    * The base URI.
    ///    */
    /// ```
    ///

    /// `attribute nsIURI baseURI;`
    #[inline]
    pub unsafe fn SetBaseURI(&self, aBaseURI: *const nsIURI) -> nsresult {
        ((*self.vtable).SetBaseURI)(self, aBaseURI)
    }


    /// ```text
    /// /**
    ///    * If the application does not register a content handler, all
    ///    * content events reported by the SAX parser will be silently
    ///    * ignored.
    ///    *
    ///    * Applications may register a new or different handler in the
    ///    * middle of a parse, and the SAX parser must begin using the new
    ///    * handler immediately.
    ///    */
    /// ```
    ///

    /// `attribute nsISAXContentHandler contentHandler;`
    #[inline]
    pub unsafe fn GetContentHandler(&self, aContentHandler: *mut *const nsISAXContentHandler) -> nsresult {
        ((*self.vtable).GetContentHandler)(self, aContentHandler)
    }


    /// ```text
    /// /**
    ///    * If the application does not register a content handler, all
    ///    * content events reported by the SAX parser will be silently
    ///    * ignored.
    ///    *
    ///    * Applications may register a new or different handler in the
    ///    * middle of a parse, and the SAX parser must begin using the new
    ///    * handler immediately.
    ///    */
    /// ```
    ///

    /// `attribute nsISAXContentHandler contentHandler;`
    #[inline]
    pub unsafe fn SetContentHandler(&self, aContentHandler: *const nsISAXContentHandler) -> nsresult {
        ((*self.vtable).SetContentHandler)(self, aContentHandler)
    }


    /// ```text
    /// /**
    ///    * If the application does not register an error handler, all
    ///    * error events reported by the SAX parser will be silently ignored;
    ///    * however, normal processing may not continue.  It is highly
    ///    * recommended that all SAX applications implement an error handler
    ///    * to avoid unexpected bugs.
    ///    *
    ///    * Applications may register a new or different handler in the
    ///    * middle of a parse, and the SAX parser must begin using the new
    ///    * handler immediately.
    ///    */
    /// ```
    ///

    /// `attribute nsISAXErrorHandler errorHandler;`
    #[inline]
    pub unsafe fn GetErrorHandler(&self, aErrorHandler: *mut *const nsISAXErrorHandler) -> nsresult {
        ((*self.vtable).GetErrorHandler)(self, aErrorHandler)
    }


    /// ```text
    /// /**
    ///    * If the application does not register an error handler, all
    ///    * error events reported by the SAX parser will be silently ignored;
    ///    * however, normal processing may not continue.  It is highly
    ///    * recommended that all SAX applications implement an error handler
    ///    * to avoid unexpected bugs.
    ///    *
    ///    * Applications may register a new or different handler in the
    ///    * middle of a parse, and the SAX parser must begin using the new
    ///    * handler immediately.
    ///    */
    /// ```
    ///

    /// `attribute nsISAXErrorHandler errorHandler;`
    #[inline]
    pub unsafe fn SetErrorHandler(&self, aErrorHandler: *const nsISAXErrorHandler) -> nsresult {
        ((*self.vtable).SetErrorHandler)(self, aErrorHandler)
    }


    /// ```text
    /// /**
    ///    * @param str The UTF16 string to be parsed
    ///    * @param contentType The content type of the string (see parseFromStream)
    ///    */
    /// ```
    ///

    /// `void parseFromString (in AString str, in string contentType);`
    #[inline]
    pub unsafe fn ParseFromString(&self, str: &::nsstring::nsAString, contentType: *const libc::c_char) -> nsresult {
        ((*self.vtable).ParseFromString)(self, str, contentType)
    }


    /// ```text
    /// /**
    ///    * @param stream The byte stream whose contents are parsed
    ///    * @param charset The character set that was used to encode the byte
    ///    *                stream. NULL if not specified.
    ///    * @param contentType The content type of the string - either text/xml,
    ///    *                    application/xml, or application/xhtml+xml.
    ///    *                    Must not be NULL.
    ///    */
    /// ```
    ///

    /// `void parseFromStream (in nsIInputStream stream, in string charset, in string contentType);`
    #[inline]
    pub unsafe fn ParseFromStream(&self, stream: *const nsIInputStream, charset: *const libc::c_char, contentType: *const libc::c_char) -> nsresult {
        ((*self.vtable).ParseFromStream)(self, stream, charset, contentType)
    }


    /// ```text
    /// /**
    ///    * Begin an asynchronous parse. This method initializes the parser,
    ///    * and must be called before any nsIStreamListener methods. It is
    ///    * then the caller's duty to call nsIStreamListener methods to drive
    ///    * the parser. Once this method is called, the caller must not call
    ///    * one of the other parse methods.
    ///    *
    ///    * @param observer The nsIRequestObserver to notify upon start or stop.
    ///    *                 Can be NULL.
    ///    */
    /// ```
    ///

    /// `void parseAsync (in nsIRequestObserver observer);`
    #[inline]
    pub unsafe fn ParseAsync(&self, observer: *const nsIRequestObserver) -> nsresult {
        ((*self.vtable).ParseAsync)(self, observer)
    }


}