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


/// `interface mozISpellI18NUtil : nsISupports`
///

/// ```text
/// /**
///  * This interface contains various I18N related code used in various places by the spell checker.
///  */
/// ```
///

// 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 mozISpellI18NUtil {
    vtable: *const mozISpellI18NUtilVTable,

    /// 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 mozISpellI18NUtil.
unsafe impl XpCom for mozISpellI18NUtil {
    const IID: nsIID = nsID(0xb075d5dc, 0x1df1, 0x441a,
        [0xbe, 0xbf, 0x68, 0x0d, 0x8c, 0xaa, 0xa1, 0x9c]);
}

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

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

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

    /* readonly attribute wstring language; */
    pub GetLanguage: unsafe extern "system" fn (this: *const mozISpellI18NUtil, aLanguage: *mut *const libc::int16_t) -> nsresult,

    /* void getRootForm (in wstring word, in uint32_t type, [array, size_is (count)] out wstring words, out uint32_t count); */
    pub GetRootForm: unsafe extern "system" fn (this: *const mozISpellI18NUtil, word: *const libc::int16_t, type_: uint32_t, words: *mut *mut *const libc::int16_t, count: *mut uint32_t) -> nsresult,

    /* void fromRootForm (in wstring word, [array, size_is (icount)] in wstring iwords, in uint32_t icount, [array, size_is (ocount)] out wstring owords, out uint32_t ocount); */
    pub FromRootForm: unsafe extern "system" fn (this: *const mozISpellI18NUtil, word: *const libc::int16_t, iwords: *mut *const libc::int16_t, icount: uint32_t, owords: *mut *mut *const libc::int16_t, ocount: *mut uint32_t) -> nsresult,

    /* void findNextWord (in wstring word, in uint32_t length, in uint32_t offset, out int32_t begin, out int32_t end); */
    pub FindNextWord: unsafe extern "system" fn (this: *const mozISpellI18NUtil, word: *const libc::int16_t, length: uint32_t, offset: uint32_t, begin: *mut int32_t, end: *mut int32_t) -> 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 mozISpellI18NUtil {

    pub const kCheck: i64 = 0;


    pub const kSuggest: i64 = 1;

    /// ```text
    /// /**
    ///     * The language being used to check spelling
    ///     */
    /// ```
    ///

    /// `readonly attribute wstring language;`
    #[inline]
    pub unsafe fn GetLanguage(&self, aLanguage: *mut *const libc::int16_t) -> nsresult {
        ((*self.vtable).GetLanguage)(self, aLanguage)
    }


    /// ```text
    /// /**
    ///     * Given a word return a list of possible root forms of that word
    ///     */
    /// ```
    ///

    /// `void getRootForm (in wstring word, in uint32_t type, [array, size_is (count)] out wstring words, out uint32_t count);`
    #[inline]
    pub unsafe fn GetRootForm(&self, word: *const libc::int16_t, type_: uint32_t, words: *mut *mut *const libc::int16_t, count: *mut uint32_t) -> nsresult {
        ((*self.vtable).GetRootForm)(self, word, type_, words, count)
    }


    /// ```text
    /// /**
    ///     * Given a word return a list of possible root forms of that word
    ///     */
    /// ```
    ///

    /// `void fromRootForm (in wstring word, [array, size_is (icount)] in wstring iwords, in uint32_t icount, [array, size_is (ocount)] out wstring owords, out uint32_t ocount);`
    #[inline]
    pub unsafe fn FromRootForm(&self, word: *const libc::int16_t, iwords: *mut *const libc::int16_t, icount: uint32_t, owords: *mut *mut *const libc::int16_t, ocount: *mut uint32_t) -> nsresult {
        ((*self.vtable).FromRootForm)(self, word, iwords, icount, owords, ocount)
    }


    /// ```text
    /// /**
    ///      * Given a unicode string and an offset, find the beginning and end of the
    ///      * next word. begin and end are -1 if there are no words remaining in the
    ///      * string. This should really be folded into the Line/WordBreaker.
    ///      */
    /// ```
    ///

    /// `void findNextWord (in wstring word, in uint32_t length, in uint32_t offset, out int32_t begin, out int32_t end);`
    #[inline]
    pub unsafe fn FindNextWord(&self, word: *const libc::int16_t, length: uint32_t, offset: uint32_t, begin: *mut int32_t, end: *mut int32_t) -> nsresult {
        ((*self.vtable).FindNextWord)(self, word, length, offset, begin, end)
    }


}