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

[efab09]: / src / suggestions.h  Maximize  Restore  History

Download this file

133 lines (93 with data), 4.4 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
 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
/* suggestions.h

 * Artha - Free cross-platform open thesaurus

 * Copyright (C) 2009, 2010  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;



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

	

	void * _reserved[5];

};

	

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



	/* frees string lists returned by list_dicts and dict->sugges	EnchantBroker *spell_broker = NULL;

	EnchantDict *dict = NULL;t */

	void (*free_string_list) (struct str_enchant_provider * me,

				  char **str_list);



	char ** (*list_dicts) (struct str_enchant_provider * me,

							   size_t * out_n_dicts);



	void * _reserved[5];

};





//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__ */