1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/* enchant
* Copyright (C) 2003 Dom Lachowicz
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
* In addition, as a special exception, Dom Lachowicz
* gives permission to link the code of this program with
* non-LGPL Spelling Provider libraries (eg: a MSFT Office
* spell checker backend) and distribute linked combinations including
* the two. You must obey the GNU Lesser General Public License in all
* respects for all of the code used other than said providers. If you modify
* this file, you may extend this exception to your version of the
* file, but you are not obligated to do so. If you do not wish to
* do so, delete this exception statement from your version.
*/
#ifndef ENCHANT_PROVIDER_H
#define ENCHANT_PROVIDER_H
#include <enchant.h>
#include <glib.h>
#include <stddef.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct str_enchant_provider EnchantProvider;
/**
* enchant_get_user_language
*
* Returns a char string giving the current language.
* Defaults to "en" if no language or locale can be found, or
* locale is C.
*
* The returned string should be free'd with free.
*/
char *enchant_get_user_language(void);
/**
* enchant_get_user_config_dir
*
* Returns a string giving the location of the user's Enchant configuration
* directory, or NULL on error, or if none exists. Defaults to the value of
* the environment variable ENCHANT_CONFIG_DIR; if that is not set, then
* glib's g_get_user_config_dir() is called to get the user's configuration
* directory, and the sub-directory "enchant" is appended.
*
* The returned string must be free'd.
*/
char *enchant_get_user_config_dir (void);
/**
* enchant_get_conf_dirs
*
* Returns a list (GSList *) of configuration directories, in the order in
* which they are used, or NULL on error.
*
* The following directories are in the list:
*
* + Enchant's internal configuration directory (pkgdatadir)
* + The system configuration directory (sysconfdir/enchant)
* + The user configuration directory, as returned by
* enchant_get_user_config_dir(), if it exists.
*/
GSList *enchant_get_conf_dirs (void);
/**
* enchant_get_prefix_dir
*
* Returns a string giving the location of the base directory of the enchant
* installation. This corresponds roughly to the --prefix option given to
* ./configure when enchant is compiled, except it is determined at runtime
* based on the location of the enchant library.
*
* The return value must be free'd.
*/
char *enchant_get_prefix_dir(void);
/**
* enchant_relocate
*
* Returns a string giving the relocated path according to the location of
* the base directory of the enchant installation.
*
* The return value must be free'd.
*/
char *enchant_relocate (const char *path);
/**
* enchant_dict_set_error
* @dict: A non-null dictionary
* @err: A non-null error message
*
* Sets the current runtime error to @err. This API is private to the
* providers.
*/
void enchant_dict_set_error (EnchantDict * dict, const char * const err);
/**
* enchant_provider_set_error
* @provider: A non-null provider
* @err: A non-null error message
*
* Sets the current runtime error to @err. This API is private to the
* providers.
*/
void enchant_provider_set_error (EnchantProvider * provider, const char * const err);
struct str_enchant_dict
{
void *user_data;
void *enchant_private_data;
int (*check) (struct str_enchant_dict * me, const char *const word,
size_t len);
/* returns utf8*/
char **(*suggest) (struct str_enchant_dict * me,
const char *const word, size_t len,
size_t * out_n_suggs);
void (*add_to_personal) (struct str_enchant_dict * me,
const char *const word, size_t len);
void (*add_to_session) (struct str_enchant_dict * me,
const char *const word, size_t len);
void (*store_replacement) (struct str_enchant_dict * me,
const char *const mis, size_t mis_len,
const char *const cor, size_t cor_len);
void (*add_to_exclude) (struct str_enchant_dict * me,
const char *const word, size_t len);
const char * (*get_extra_word_characters) (struct str_enchant_dict * me);
int (*is_word_character) (struct str_enchant_dict * me,
uint32_t uc_in, size_t n);
};
struct str_enchant_provider
{
void *user_data;
void *enchant_private_data;
EnchantBroker * owner;
void (*dispose) (struct str_enchant_provider * me);
EnchantDict *(*request_dict) (struct str_enchant_provider * me,
const char *const tag);
void (*dispose_dict) (struct str_enchant_provider * me,
EnchantDict * dict);
int (*dictionary_exists) (struct str_enchant_provider * me,
const char *const tag);
/* returns utf8*/
const char * (*identify) (struct str_enchant_provider * me);
/* returns utf8*/
const char * (*describe) (struct str_enchant_provider * me);
char ** (*list_dicts) (struct str_enchant_provider * me,
size_t * out_n_dicts);
};
#ifdef __cplusplus
}
#endif
#endif /* ENCHANT_PROVIDER_H */
|
