/* accidence
 * Copyright (C) 2007 Gabriel Bakiewicz
 *
 * 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., 59 Temple Place - Suite 330,
 * Boston, MA 02110-1301, USA.
 *
 */

#ifndef ACCIDENCE_H
#define ACCIDENCE_H

#include <sys/types.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifdef _WIN32
#ifdef _ACCIDENCE_BUILD
#define ACCIDENCE_MODULE_EXPORT(x) __declspec(dllexport) x
#else
#define ACCIDENCE_MODULE_EXPORT(x) __declspec(dllimport) x
#endif
#else
#define ACCIDENCE_MODULE_EXPORT(x) x
#endif

typedef struct _AccidenceBroker 	AccidenceBroker;
typedef struct _AccidenceChecker 	AccidenceChecker;
typedef struct _AccidenceMistake 	AccidenceMistake;

struct _AccidenceMistake
{
	unsigned int pos_start;
	unsigned int pos_end;
	char *message;
	unsigned int num_suggestions;
	char **suggestions;

	struct _AccidenceMistake *next;
};

typedef enum {
	ACCIDENCE_CHECK_OK = 0,
	ACCIDENCE_CHECK_MISTAKES,
	ACCIDENCE_CHECK_ERROR
} accidence_check_status;

/*
 * Accidence Broker functions
 */
ACCIDENCE_MODULE_EXPORT (AccidenceBroker*)
			accidence_broker_init 		        (void);

ACCIDENCE_MODULE_EXPORT (void)
        	accidence_broker_free 		        (AccidenceBroker *broker);

ACCIDENCE_MODULE_EXPORT (AccidenceChecker*)
        	accidence_broker_request_checker    (AccidenceBroker *broker,
                                             const char *const tag);

ACCIDENCE_MODULE_EXPORT (int)
        	accidence_broker_checker_exists	    (AccidenceBroker *broker,
                                             const char *const tag);

ACCIDENCE_MODULE_EXPORT (void)
        	accidence_broker_set_ordering 	    (AccidenceBroker *broker,
                                             char *tag,
                                             char *ordering);

ACCIDENCE_MODULE_EXPORT (void)
			accidence_broker_free_checker	    (AccidenceBroker *broker,
                                             AccidenceChecker *checker,
                                             const char *const lang);

typedef void (*AccidenceBrokerDescribeFn) 	(const char *const provider_name,
											 const char *const provider_desc,
											 const char *const provider_dll_file,
											 void *user_data);

ACCIDENCE_MODULE_EXPORT (void)
        	accidence_broker_describe	        (AccidenceBroker *broker,
                                             AccidenceBrokerDescribeFn fn,
                                             void *user_data);
ACCIDENCE_MODULE_EXPORT (char *)
			accidence_broker_get_error			(AccidenceBroker *broker);

/*
 * Accidence Checker functions
 */
ACCIDENCE_MODULE_EXPORT (accidence_check_status)
			accidence_checker_check 	        (AccidenceChecker *checker,
                                             const char *const sentence);

ACCIDENCE_MODULE_EXPORT (AccidenceMistake *)
			accidence_checker_get_mistakes 	    (AccidenceChecker *checker);

ACCIDENCE_MODULE_EXPORT (void)
			accidence_checker_free_mistakes     (AccidenceChecker *checker,
                                             AccidenceMistake *mistakes);

typedef void 		(*AccidenceCheckerDescribeFn) 	(const char *const lang_tag,
                            const char *const provider_name,
							const char *const provider_desc,
							const char *const provider_file,
							void *user_data);

ACCIDENCE_MODULE_EXPORT (void)
        accidence_checker_describe 	        (AccidenceChecker *checker,
                                             AccidenceCheckerDescribeFn fn,
                                             void *user_data,
                                             const char *lang);

ACCIDENCE_MODULE_EXPORT(char *)
		accidence_checker_get_error 		(AccidenceChecker *checker);

#ifdef __cplusplus
} /* close extern "C" */
#endif

#endif /* ACCIDENCE_H */