/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Copyright (C) 2006
 * Miha Vrhovnik (http://simail.sf.net, http://xcollect.sf.net)
 * All Rights Reserved.
 *
 * Contributor(s):
 *
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** **/
#include "hunspell.hxx"

#ifndef HUNSPELLDLL_H_
#define HUNSPELLDLL_H_

#ifdef __cplusplus
extern "C" {
#endif

// returns pointer to spell object, params are aff file name and dict file name
LIBHUNSPELL_DLL_EXPORTED void* hunspell_initialize(char* aff_file,
                                                   char* dict_file);
// frees spell object
LIBHUNSPELL_DLL_EXPORTED void hunspell_uninitialize(Hunspell* pMS);

// spellcheck word, returns 1 if word ok otherwise 0
LIBHUNSPELL_DLL_EXPORTED int hunspell_spell(Hunspell* pMS, char* word);

// suggest words for word, returns number of words in slst
// YOU NEED TO CALL hunspell_free_list after you've done with words
LIBHUNSPELL_DLL_EXPORTED int hunspell_suggest(Hunspell* pMS,
                                              char* word,
                                              char*** slst);
// free slst array
LIBHUNSPELL_DLL_EXPORTED void hunspell_free_list(Hunspell* pMS,
                                                 char*** slst,
                                                 int len);
// make local copy of returned string!!
LIBHUNSPELL_DLL_EXPORTED char* hunspell_get_dic_encoding(Hunspell* pMS);

// add word to dict (word is valid until spell object is not destroyed)
LIBHUNSPELL_DLL_EXPORTED int hunspell_add(Hunspell* pMS, char* word);

// add word to dict with affixes of the modelword (word is valid until spell
// object is not destroyed)
LIBHUNSPELL_DLL_EXPORTED int hunspell_add_with_affix(Hunspell* pMS,
                                                     char* word,
                                                     char* modelword);
// remove word from dict
LIBHUNSPELL_DLL_EXPORTED int hunspell_remove(Hunspell* pMS, char* word);

#ifdef __cplusplus
}
#endif

#endif /* HUNSPELLDLL_H_ */
