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


/// `interface nsIScriptableUnescapeHTML : nsISupports`
///

/// ```text
/// /**
///  * This interface is OBSOLETE and exists solely for legacy extensions.
///  */
/// ```
///

// 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 nsIScriptableUnescapeHTML {
    vtable: *const nsIScriptableUnescapeHTMLVTable,

    /// 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 nsIScriptableUnescapeHTML.
unsafe impl XpCom for nsIScriptableUnescapeHTML {
    const IID: nsIID = nsID(0x3ab244a9, 0xf09d, 0x44da,
        [0x9e, 0x3f, 0xee, 0x4d, 0x67, 0x36, 0x7f, 0x2d]);
}

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

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

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

    /* AString unescape (in AString src); */
    pub Unescape: unsafe extern "system" fn (this: *const nsIScriptableUnescapeHTML, src: &::nsstring::nsAString, _retval: &mut ::nsstring::nsAString) -> nsresult,

    /* nsIDOMDocumentFragment parseFragment (in AString fragment, in boolean isXML, in nsIURI baseURI, in nsIDOMElement element); */
    pub ParseFragment: unsafe extern "system" fn (this: *const nsIScriptableUnescapeHTML, fragment: &::nsstring::nsAString, isXML: bool, baseURI: *const nsIURI, element: *const nsIDOMElement, _retval: *mut *const nsIDOMDocumentFragment) -> 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 nsIScriptableUnescapeHTML {

    /// ```text
    /// /**
    ///    * Converts HTML to plain text. This is equivalent to calling
    ///    * nsIParserUtils::convertToPlainText(src,
        ///    *   nsIDocumentEncoder::OutputSelectionOnly |
        ///    *   nsIDocumentEncoder::OutputAbsoluteLinks, 0).
    ///    *
    ///    * You should call nsIParserUtils::convertToPlainText() instead of calling
    ///    * this method.
    ///    *
    ///    * @param src The HTML string to convert to plain text.
    ///    */
    /// ```
    ///

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


    /// ```text
    /// /**
    ///    * Parses markup into a sanitized document fragment. This is equivalent to
    ///    * calling nsIParserUtils::parseFragment(fragment, 0, isXML, baseURI,
        ///    * element).
    ///    *
    ///    * You should call nsIParserUtils::parseFragment() instead of calling this
    ///    * method.
    ///    * @param fragment the input markup
    ///    * @param isXML true if |fragment| is XML and false if HTML
    ///    * @param baseURI the base URL for this fragment
    ///    * @param element the context node for the fragment parsing algorithm
    ///    */
    /// ```
    ///

    /// `nsIDOMDocumentFragment parseFragment (in AString fragment, in boolean isXML, in nsIURI baseURI, in nsIDOMElement element);`
    #[inline]
    pub unsafe fn ParseFragment(&self, fragment: &::nsstring::nsAString, isXML: bool, baseURI: *const nsIURI, element: *const nsIDOMElement, _retval: *mut *const nsIDOMDocumentFragment) -> nsresult {
        ((*self.vtable).ParseFragment)(self, fragment, isXML, baseURI, element, _retval)
    }


}