Enchant 2.8.6
Generic spell checking library
Loading...
Searching...
No Matches
enchant.h
Go to the documentation of this file.
1
30#ifndef ENCHANT_H
31#define ENCHANT_H
32
33#include <stdint.h> /* for uint32_t */
34#include <sys/types.h> /* for size_t, ssize_t */
35
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41typedef struct _EnchantBroker EnchantBroker;
42typedef struct _EnchantDict EnchantDict;
43
44const char *enchant_get_version (void);
45
57EnchantBroker *enchant_broker_init (void);
58
65void enchant_broker_free (EnchantBroker * broker);
66
76EnchantDict *enchant_broker_request_dict (EnchantBroker * broker, const char *const tag);
77
90EnchantDict *enchant_broker_request_dict_with_pwl (EnchantBroker * broker, const char *const tag, const char *pwl);
91
99EnchantDict *enchant_broker_request_pwl_dict (EnchantBroker * broker, const char *const pwl);
100
109void enchant_broker_free_dict (EnchantBroker * broker, EnchantDict * dict);
110
119int enchant_broker_dict_exists (EnchantBroker * broker, const char * const tag);
120
130void enchant_broker_set_ordering (EnchantBroker * broker,
131 const char * const tag,
132 const char * const ordering);
142const char *enchant_broker_get_error (EnchantBroker * broker);
143
154typedef void (*EnchantBrokerDescribeFn) (const char * const provider_name,
155 const char * const provider_desc,
156 const char * const provider_dll_file,
157 void * user_data);
158
168void enchant_broker_describe (EnchantBroker * broker,
170 void * user_data);
171
181int enchant_dict_check (EnchantDict * dict, const char *const word, ssize_t len);
182
194char **enchant_dict_suggest (EnchantDict * dict, const char *const word,
195 ssize_t len, size_t * out_n_suggs);
196
206void enchant_dict_add (EnchantDict * dict, const char *const word, ssize_t len);
207
214void enchant_dict_add_to_session (EnchantDict * dict, const char *const word, ssize_t len);
215
225void enchant_dict_remove (EnchantDict * dict, const char *const word, ssize_t len);
226
233void enchant_dict_remove_from_session (EnchantDict * dict, const char *const word, ssize_t len);
234
243int enchant_dict_is_added (EnchantDict * dict, const char *const word, ssize_t len);
244
255int enchant_dict_is_removed (EnchantDict * dict, const char *const word, ssize_t len);
256
268void enchant_dict_store_replacement (EnchantDict * dict,
269 const char *const mis, ssize_t mis_len,
270 const char *const cor, ssize_t cor_len);
271
279void enchant_dict_free_string_list (EnchantDict * dict, char **string_list);
280
290const char *enchant_dict_get_error (EnchantDict * dict);
291
304const char *enchant_dict_get_extra_word_characters (EnchantDict * dict);
305
333int enchant_dict_is_word_character (EnchantDict * dict, uint32_t uc, size_t n);
334
346typedef void (*EnchantDictDescribeFn) (const char * const lang_tag,
347 const char * const provider_name,
348 const char * const provider_desc,
349 const char * const provider_file,
350 void * user_data);
351
360void enchant_dict_describe (EnchantDict * dict,
362 void * user_data);
363
372void enchant_broker_list_dicts (EnchantBroker * broker,
374 void * user_data);
375
382void enchant_set_prefix_dir(const char *);
383
384#ifdef __cplusplus
385}
386#endif
387
388#endif /* ENCHANT_H */
void enchant_dict_store_replacement(EnchantDict *dict, const char *const mis, ssize_t mis_len, const char *const cor, ssize_t cor_len)
void(* EnchantBrokerDescribeFn)(const char *const provider_name, const char *const provider_desc, const char *const provider_dll_file, void *user_data)
Definition enchant.h:154
const char * enchant_broker_get_error(EnchantBroker *broker)
void enchant_broker_set_ordering(EnchantBroker *broker, const char *const tag, const char *const ordering)
void enchant_set_prefix_dir(const char *)
EnchantDict * enchant_broker_request_dict_with_pwl(EnchantBroker *broker, const char *const tag, const char *pwl)
void enchant_dict_remove_from_session(EnchantDict *dict, const char *const word, ssize_t len)
int enchant_dict_is_word_character(EnchantDict *dict, uint32_t uc, size_t n)
const char * enchant_dict_get_extra_word_characters(EnchantDict *dict)
char ** enchant_dict_suggest(EnchantDict *dict, const char *const word, ssize_t len, size_t *out_n_suggs)
void enchant_broker_free(EnchantBroker *broker)
int enchant_dict_is_added(EnchantDict *dict, const char *const word, ssize_t len)
EnchantDict * enchant_broker_request_dict(EnchantBroker *broker, const char *const tag)
int enchant_broker_dict_exists(EnchantBroker *broker, const char *const tag)
void enchant_dict_add_to_session(EnchantDict *dict, const char *const word, ssize_t len)
void enchant_dict_describe(EnchantDict *dict, EnchantDictDescribeFn fn, void *user_data)
EnchantDict * enchant_broker_request_pwl_dict(EnchantBroker *broker, const char *const pwl)
const char * enchant_dict_get_error(EnchantDict *dict)
void enchant_broker_free_dict(EnchantBroker *broker, EnchantDict *dict)
void enchant_dict_free_string_list(EnchantDict *dict, char **string_list)
void enchant_dict_add(EnchantDict *dict, const char *const word, ssize_t len)
void(* EnchantDictDescribeFn)(const char *const lang_tag, const char *const provider_name, const char *const provider_desc, const char *const provider_file, void *user_data)
Definition enchant.h:346
EnchantBroker * enchant_broker_init(void)
int enchant_dict_is_removed(EnchantDict *dict, const char *const word, ssize_t len)
void enchant_dict_remove(EnchantDict *dict, const char *const word, ssize_t len)
int enchant_dict_check(EnchantDict *dict, const char *const word, ssize_t len)