[go: up one dir, main page]
Menu ▾ ▴

[4c9db1]: / src / suggestions.h  Maximize  Restore  History

Download this file

70 lines (48 with data), 2.7 kB 

 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
/* suggestions.h

 * Artha - Free cross-platform open thesaurus

 * Copyright (c) 2009 Sundaram Ramaswamy, legends2k@yahoo.com

 *

 * Artha is free software: you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation, either version 2 of the License, or

 * (at your option) any later version.

 *

 * Artha 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 General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with Artha; if not, write to the Free Software Foundation, Inc., 

 * 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */





/*

 * Dynamic linking of libenchant for spell checks using GModule.

 * Prototypes must match with enchant.h and enchant-provider.h

 */





#ifndef __SUGGESTIONS_H__

#define __SUGGESTIONS_H__



G_BEGIN_DECLS



//Structure Prototypes



typedef struct str_enchant_broker EnchantBroker;

typedef struct str_enchant_dict   EnchantDict;



//Function Prototypes



typedef 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);





EnchantBroker*	(*enchant_broker_init)			(void) = NULL;

void		(*enchant_broker_free)			(EnchantBroker * broker) = NULL;





int		(*enchant_broker_dict_exists)		(EnchantBroker * broker, const char * const tag) = NULL;

void		(*enchant_broker_list_dicts)		(EnchantBroker * broker, EnchantDictDescribeFn fn, void * user_data) = NULL;

EnchantDict*	(*enchant_broker_request_dict)		(EnchantBroker * broker, const char *const tag) = NULL;

void		(*enchant_broker_free_dict)		(EnchantBroker * broker, EnchantDict * dict) = NULL;





int		(*enchant_dict_check)			(EnchantDict * dict, const char *const word, ssize_t len) = NULL;

char**		(*enchant_dict_suggest)			(EnchantDict * dict, const char *const word, ssize_t len, size_t * out_n_suggs) = NULL;

void		(*enchant_dict_free_string_list)	(EnchantDict * dict, char **string_list) = NULL;



// The function decl. is commented because it has the same prototype as dict_free_string_list

// free suggestions is depricated, only if enchant_dict_free_string_list is not available, should it be used

//void		(*enchant_dict_free_suggestions)	(EnchantDict * dict, char **suggestions) = NULL;



char*		(*enchant_dict_get_error)		(EnchantDict * dict) = NULL;

char*		(*enchant_broker_get_error)		(EnchantBroker * broker) = NULL;





G_END_DECLS



#endif		/* __SUGGESTIONS_H__ */