/extensions/spellcheck/hunspell/src/hunspell.h

http://github.com/zpao/v8monkey · C Header · 152 lines · 29 code · 32 blank · 91 comment · 0 complexity · 4ad4896090f2475fd5409e0c08209a7e MD5 · raw file

  1. /******* BEGIN LICENSE BLOCK *******
  2. * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3. *
  4. * The contents of this file are subject to the Mozilla Public License Version
  5. * 1.1 (the "License"); you may not use this file except in compliance with
  6. * the License. You may obtain a copy of the License at
  7. * http://www.mozilla.org/MPL/
  8. *
  9. * Software distributed under the License is distributed on an "AS IS" basis,
  10. * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11. * for the specific language governing rights and limitations under the
  12. * License.
  13. *
  14. * The Initial Developers of the Original Code are Kevin Hendricks (MySpell)
  15. * and László Németh (Hunspell). Portions created by the Initial Developers
  16. * are Copyright (C) 2002-2005 the Initial Developers. All Rights Reserved.
  17. *
  18. * Contributor(s): Kevin Hendricks (kevin.hendricks@sympatico.ca)
  19. * David Einstein (deinst@world.std.com)
  20. * László Németh (nemethl@gyorsposta.hu)
  21. * Caolan McNamara (caolanm@redhat.com)
  22. * Davide Prina
  23. * Giuseppe Modugno
  24. * Gianluca Turconi
  25. * Simon Brouwer
  26. * Noll Janos
  27. * Biro Arpad
  28. * Goldman Eleonora
  29. * Sarlos Tamas
  30. * Bencsath Boldizsar
  31. * Halacsy Peter
  32. * Dvornik Laszlo
  33. * Gefferth Andras
  34. * Nagy Viktor
  35. * Varga Daniel
  36. * Chris Halls
  37. * Rene Engelhard
  38. * Bram Moolenaar
  39. * Dafydd Jones
  40. * Harri Pitkanen
  41. * Andras Timar
  42. * Tor Lillqvist
  43. *
  44. * Alternatively, the contents of this file may be used under the terms of
  45. * either the GNU General Public License Version 2 or later (the "GPL"), or
  46. * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  47. * in which case the provisions of the GPL or the LGPL are applicable instead
  48. * of those above. If you wish to allow use of your version of this file only
  49. * under the terms of either the GPL or the LGPL, and not to allow others to
  50. * use your version of this file under the terms of the MPL, indicate your
  51. * decision by deleting the provisions above and replace them with the notice
  52. * and other provisions required by the GPL or the LGPL. If you do not delete
  53. * the provisions above, a recipient may use your version of this file under
  54. * the terms of any one of the MPL, the GPL or the LGPL.
  55. *
  56. ******* END LICENSE BLOCK *******/
  57. #ifndef _MYSPELLMGR_H_
  58. #define _MYSPELLMGR_H_
  59. #include "hunvisapi.h"
  60. #ifdef __cplusplus
  61. extern "C" {
  62. #endif
  63. typedef struct Hunhandle Hunhandle;
  64. LIBHUNSPELL_DLL_EXPORTED Hunhandle *Hunspell_create(const char * affpath, const char * dpath);
  65. LIBHUNSPELL_DLL_EXPORTED Hunhandle *Hunspell_create_key(const char * affpath, const char * dpath,
  66. const char * key);
  67. LIBHUNSPELL_DLL_EXPORTED void Hunspell_destroy(Hunhandle *pHunspell);
  68. /* spell(word) - spellcheck word
  69. * output: 0 = bad word, not 0 = good word
  70. */
  71. LIBHUNSPELL_DLL_EXPORTED int Hunspell_spell(Hunhandle *pHunspell, const char *);
  72. LIBHUNSPELL_DLL_EXPORTED char *Hunspell_get_dic_encoding(Hunhandle *pHunspell);
  73. /* suggest(suggestions, word) - search suggestions
  74. * input: pointer to an array of strings pointer and the (bad) word
  75. * array of strings pointer (here *slst) may not be initialized
  76. * output: number of suggestions in string array, and suggestions in
  77. * a newly allocated array of strings (*slts will be NULL when number
  78. * of suggestion equals 0.)
  79. */
  80. LIBHUNSPELL_DLL_EXPORTED int Hunspell_suggest(Hunhandle *pHunspell, char*** slst, const char * word);
  81. /* morphological functions */
  82. /* analyze(result, word) - morphological analysis of the word */
  83. LIBHUNSPELL_DLL_EXPORTED int Hunspell_analyze(Hunhandle *pHunspell, char*** slst, const char * word);
  84. /* stem(result, word) - stemmer function */
  85. LIBHUNSPELL_DLL_EXPORTED int Hunspell_stem(Hunhandle *pHunspell, char*** slst, const char * word);
  86. /* stem(result, analysis, n) - get stems from a morph. analysis
  87. * example:
  88. * char ** result, result2;
  89. * int n1 = Hunspell_analyze(result, "words");
  90. * int n2 = Hunspell_stem2(result2, result, n1);
  91. */
  92. LIBHUNSPELL_DLL_EXPORTED int Hunspell_stem2(Hunhandle *pHunspell, char*** slst, char** desc, int n);
  93. /* generate(result, word, word2) - morphological generation by example(s) */
  94. LIBHUNSPELL_DLL_EXPORTED int Hunspell_generate(Hunhandle *pHunspell, char*** slst, const char * word,
  95. const char * word2);
  96. /* generate(result, word, desc, n) - generation by morph. description(s)
  97. * example:
  98. * char ** result;
  99. * char * affix = "is:plural"; // description depends from dictionaries, too
  100. * int n = Hunspell_generate2(result, "word", &affix, 1);
  101. * for (int i = 0; i < n; i++) printf("%s\n", result[i]);
  102. */
  103. LIBHUNSPELL_DLL_EXPORTED int Hunspell_generate2(Hunhandle *pHunspell, char*** slst, const char * word,
  104. char** desc, int n);
  105. /* functions for run-time modification of the dictionary */
  106. /* add word to the run-time dictionary */
  107. LIBHUNSPELL_DLL_EXPORTED int Hunspell_add(Hunhandle *pHunspell, const char * word);
  108. /* add word to the run-time dictionary with affix flags of
  109. * the example (a dictionary word): Hunspell will recognize
  110. * affixed forms of the new word, too.
  111. */
  112. LIBHUNSPELL_DLL_EXPORTED int Hunspell_add_with_affix(Hunhandle *pHunspell, const char * word, const char * example);
  113. /* remove word from the run-time dictionary */
  114. LIBHUNSPELL_DLL_EXPORTED int Hunspell_remove(Hunhandle *pHunspell, const char * word);
  115. /* free suggestion lists */
  116. LIBHUNSPELL_DLL_EXPORTED void Hunspell_free_list(Hunhandle *pHunspell, char *** slst, int n);
  117. #ifdef __cplusplus
  118. }
  119. #endif
  120. #endif