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