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


/// `interface mozISpellCheckingEngine : nsISupports`
///

/// ```text
/// /**
///  * This interface represents a SpellChecker.
///  */
/// ```
///

// 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 mozISpellCheckingEngine {
    vtable: *const mozISpellCheckingEngineVTable,

    /// 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 mozISpellCheckingEngine.
unsafe impl XpCom for mozISpellCheckingEngine {
    const IID: nsIID = nsID(0x8ba643a4, 0x7ddc, 0x4662,
        [0xb9, 0x76, 0x7e, 0xc1, 0x23, 0x84, 0x3f, 0x10]);
}

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

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

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

    /* attribute wstring dictionary; */
    pub GetDictionary: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, aDictionary: *mut *const libc::int16_t) -> nsresult,

    /* attribute wstring dictionary; */
    pub SetDictionary: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, aDictionary: *const libc::int16_t) -> nsresult,

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

    /* readonly attribute boolean providesPersonalDictionary; */
    pub GetProvidesPersonalDictionary: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, aProvidesPersonalDictionary: *mut bool) -> nsresult,

    /* readonly attribute boolean providesWordUtils; */
    pub GetProvidesWordUtils: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, aProvidesWordUtils: *mut bool) -> nsresult,

    /* readonly attribute wstring name; */
    pub GetName: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, aName: *mut *const libc::int16_t) -> nsresult,

    /* readonly attribute wstring copyright; */
    pub GetCopyright: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, aCopyright: *mut *const libc::int16_t) -> nsresult,

    /* attribute mozIPersonalDictionary personalDictionary; */
    pub GetPersonalDictionary: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, aPersonalDictionary: *mut *const mozIPersonalDictionary) -> nsresult,

    /* attribute mozIPersonalDictionary personalDictionary; */
    pub SetPersonalDictionary: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, aPersonalDictionary: *const mozIPersonalDictionary) -> nsresult,

    /* void getDictionaryList ([array, size_is (count)] out wstring dictionaries, out uint32_t count); */
    pub GetDictionaryList: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, dictionaries: *mut *mut *const libc::int16_t, count: *mut uint32_t) -> nsresult,

    /* boolean check (in wstring word); */
    pub Check: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, word: *const libc::int16_t, _retval: *mut bool) -> nsresult,

    /* void suggest (in wstring word, [array, size_is (count)] out wstring suggestions, out uint32_t count); */
    pub Suggest: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, word: *const libc::int16_t, suggestions: *mut *mut *const libc::int16_t, count: *mut uint32_t) -> nsresult,

    /* void loadDictionariesFromDir (in nsIFile dir); */
    pub LoadDictionariesFromDir: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, dir: *const nsIFile) -> nsresult,

    /* void addDirectory (in nsIFile dir); */
    pub AddDirectory: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, dir: *const nsIFile) -> nsresult,

    /* void removeDirectory (in nsIFile dir); */
    pub RemoveDirectory: unsafe extern "system" fn (this: *const mozISpellCheckingEngine, dir: *const nsIFile) -> 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 mozISpellCheckingEngine {

    /// ```text
    /// /**
    ///    * The name of the current dictionary. Is either a value from
    ///    * getDictionaryList or the empty string if no dictionary is selected.
    ///    * Setting this attribute to a value not in getDictionaryList will throw
    ///    * NS_ERROR_FILE_NOT_FOUND.
    ///    *
    ///    * If the dictionary is changed to no dictionary (the empty string), an
    ///    * observer is allowed to set another dictionary before it returns.
    ///    */
    /// ```
    ///

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


    /// ```text
    /// /**
    ///    * The name of the current dictionary. Is either a value from
    ///    * getDictionaryList or the empty string if no dictionary is selected.
    ///    * Setting this attribute to a value not in getDictionaryList will throw
    ///    * NS_ERROR_FILE_NOT_FOUND.
    ///    *
    ///    * If the dictionary is changed to no dictionary (the empty string), an
    ///    * observer is allowed to set another dictionary before it returns.
    ///    */
    /// ```
    ///

    /// `attribute wstring dictionary;`
    #[inline]
    pub unsafe fn SetDictionary(&self, aDictionary: *const libc::int16_t) -> nsresult {
        ((*self.vtable).SetDictionary)(self, aDictionary)
    }


    /// ```text
    /// /**
    ///    * The language this spellchecker is using when checking
    ///    */
    /// ```
    ///

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


    /// ```text
    /// /**
    ///    * Does the engine provide its own personal dictionary?
    ///    */
    /// ```
    ///

    /// `readonly attribute boolean providesPersonalDictionary;`
    #[inline]
    pub unsafe fn GetProvidesPersonalDictionary(&self, aProvidesPersonalDictionary: *mut bool) -> nsresult {
        ((*self.vtable).GetProvidesPersonalDictionary)(self, aProvidesPersonalDictionary)
    }


    /// ```text
    /// /**
    ///    * Does the engine provide its own word utils?
    ///    */
    /// ```
    ///

    /// `readonly attribute boolean providesWordUtils;`
    #[inline]
    pub unsafe fn GetProvidesWordUtils(&self, aProvidesWordUtils: *mut bool) -> nsresult {
        ((*self.vtable).GetProvidesWordUtils)(self, aProvidesWordUtils)
    }


    /// ```text
    /// /**
    ///    * The name of the engine
    ///    */
    /// ```
    ///

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


    /// ```text
    /// /**
    ///    * a string indicating the copyright of the engine
    ///    */
    /// ```
    ///

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


    /// ```text
    /// /**
    ///    * the personal dictionary
    ///    */
    /// ```
    ///

    /// `attribute mozIPersonalDictionary personalDictionary;`
    #[inline]
    pub unsafe fn GetPersonalDictionary(&self, aPersonalDictionary: *mut *const mozIPersonalDictionary) -> nsresult {
        ((*self.vtable).GetPersonalDictionary)(self, aPersonalDictionary)
    }


    /// ```text
    /// /**
    ///    * the personal dictionary
    ///    */
    /// ```
    ///

    /// `attribute mozIPersonalDictionary personalDictionary;`
    #[inline]
    pub unsafe fn SetPersonalDictionary(&self, aPersonalDictionary: *const mozIPersonalDictionary) -> nsresult {
        ((*self.vtable).SetPersonalDictionary)(self, aPersonalDictionary)
    }


    /// ```text
    /// /**
    ///    * Get the list of dictionaries
    ///    */
    /// ```
    ///

    /// `void getDictionaryList ([array, size_is (count)] out wstring dictionaries, out uint32_t count);`
    #[inline]
    pub unsafe fn GetDictionaryList(&self, dictionaries: *mut *mut *const libc::int16_t, count: *mut uint32_t) -> nsresult {
        ((*self.vtable).GetDictionaryList)(self, dictionaries, count)
    }


    /// ```text
    /// /**
    ///    * check a word
    ///    */
    /// ```
    ///

    /// `boolean check (in wstring word);`
    #[inline]
    pub unsafe fn Check(&self, word: *const libc::int16_t, _retval: *mut bool) -> nsresult {
        ((*self.vtable).Check)(self, word, _retval)
    }


    /// ```text
    /// /**
    ///    * get a list of suggestions for a misspelled word
    ///    */
    /// ```
    ///

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


    /// ```text
    /// /**
    ///    * Load dictionaries from the specified dir
    ///    */
    /// ```
    ///

    /// `void loadDictionariesFromDir (in nsIFile dir);`
    #[inline]
    pub unsafe fn LoadDictionariesFromDir(&self, dir: *const nsIFile) -> nsresult {
        ((*self.vtable).LoadDictionariesFromDir)(self, dir)
    }


    /// ```text
    /// /**
    ///    * Add dictionaries from a directory to the spell checker
    ///    */
    /// ```
    ///

    /// `void addDirectory (in nsIFile dir);`
    #[inline]
    pub unsafe fn AddDirectory(&self, dir: *const nsIFile) -> nsresult {
        ((*self.vtable).AddDirectory)(self, dir)
    }


    /// ```text
    /// /**
    ///    * Remove dictionaries from a directory from the spell checker
    ///    */
    /// ```
    ///

    /// `void removeDirectory (in nsIFile dir);`
    #[inline]
    pub unsafe fn RemoveDirectory(&self, dir: *const nsIFile) -> nsresult {
        ((*self.vtable).RemoveDirectory)(self, dir)
    }


}