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


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

    /// 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 nsIUTF8ConverterService.
unsafe impl XpCom for nsIUTF8ConverterService {
    const IID: nsIID = nsID(0x249f52a3, 0x2599, 0x4b00,
        [0xba, 0x40, 0x04, 0x81, 0x36, 0x48, 0x31, 0xa2]);
}

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

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

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

    /* [optional_argc] AUTF8String convertStringToUTF8 (in ACString aString, in string aCharset, in boolean aSkipCheck, [optional] in boolean aAllowSubstitution); */
    /// Unable to generate binding because `optional_argc is unsupported`
    pub ConvertStringToUTF8: *const ::libc::c_void,

    /* AUTF8String convertURISpecToUTF8 (in ACString aSpec, in string aCharset); */
    pub ConvertURISpecToUTF8: unsafe extern "system" fn (this: *const nsIUTF8ConverterService, aSpec: &::nsstring::nsACString, aCharset: *const libc::c_char, _retval: &mut ::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 nsIUTF8ConverterService {

    /// ```text
    /// /**
    ///    * Ensure that |aString| is encoded in UTF-8.  If not,
    ///    * convert to UTF-8 assuming it's encoded in |aCharset|
    ///    * and return the converted string in UTF-8.
    ///    *
    ///    * @param aString a string to  ensure its UTF8ness
    ///    * @param aCharset the charset to convert from if |aString| is not in UTF-8
    ///    * @param aSkipCheck determines whether or not to skip 'ASCIIness' and
    ///    *        'UTF8ness' check. Set this to PR_TRUE only if you suspect that
    ///    *        aString can be mistaken for ASCII / UTF-8 but is actually NOT
    ///    *        in ASCII / UTF-8 so that aString has to go through the conversion.
    ///    *        skipping ASCIIness/UTF8ness check.
    ///    *        The most common case is the input is in 7bit non-ASCII charsets
    ///    *        like ISO-2022-JP, HZ or UTF-7 (in its original form or
        ///    *        a modified form used in IMAP folder names).
    ///    * @param aAllowSubstitution when true, allow the decoder to substitute
    ///    *        invalid input sequences by replacement characters (defaults to
        ///    *        true)
    ///    * @return the converted string in UTF-8.
    ///    * @throws NS_ERROR_UCONV_NOCONV when there is no decoder for aCharset
    ///    *         or NS_ERROR_UDEC_ILLEGALINPUT in case of conversion failure
    ///    */
    /// ```
    ///

    /// `[optional_argc] AUTF8String convertStringToUTF8 (in ACString aString, in string aCharset, in boolean aSkipCheck, [optional] in boolean aAllowSubstitution);`
    const _ConvertStringToUTF8: () = ();

    /// ```text
    /// /**
    ///    * Ensure that |aSpec| (after URL-unescaping it) is encoded in UTF-8.
    ///    * If not,  convert it to UTF-8, assuming it's encoded in |aCharset|,
    ///    * and return the result.
    ///    *
    ///    * <p>Make sure that all characters outside US-ASCII in your input spec
    ///    * are url-escaped if  your spec is not in UTF-8 (before url-escaping)
    ///    * because the presence of non-ASCII characters is <strong>blindly</strong>
    ///    * regarded as an indication that your input spec is in unescaped UTF-8
    ///    * and it will be returned without further processing. No valid spec
    ///    * going around in Mozilla code would break this assumption.
    ///    *
    ///    * <p>XXX The above may change in the future depending on the usage pattern.
    ///    *
    ///    * @param aSpec an url-escaped URI spec to  ensure its UTF8ness
    ///    * @param aCharset the charset to convert from if |aSpec| is not in UTF-8
    ///    * @return the converted spec in UTF-8.
    ///    * @throws NS_ERROR_UCONV_NOCONV when there is no decoder for aCharset
    ///    *         or NS_ERROR_UDEC_ILLEGALINPUT in case of conversion failure
    ///    */
    /// ```
    ///

    /// `AUTF8String convertURISpecToUTF8 (in ACString aSpec, in string aCharset);`
    #[inline]
    pub unsafe fn ConvertURISpecToUTF8(&self, aSpec: &::nsstring::nsACString, aCharset: *const libc::c_char, _retval: &mut ::nsstring::nsACString) -> nsresult {
        ((*self.vtable).ConvertURISpecToUTF8)(self, aSpec, aCharset, _retval)
    }


}