/*
 * Copyright 2008 Red Hat, Inc.
 *
 * This Program 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; version 2 of the License.
 *
 * This Program 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 this Program; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307 USA
 *
 */

#ifndef map_h
#define map_h
struct plugin_state;
struct slapi_pblock;
/* Functions to pull data out of maps. */
int map_startup(struct plugin_state *state);
int map_init(struct slapi_pblock *pb, struct plugin_state *state);
int map_master_name(struct plugin_state *state, const char **master);
bool_t map_supports_domain(struct plugin_state *state,
			   const char *domain,
			   bool_t *supported);
bool_t map_supports_map(struct plugin_state *state,
			const char *domain,
			const char *map,
			bool_t *supported);
bool_t map_match(struct plugin_state *state,
		 const char *domain, const char *map,
		 unsigned int key_len, char *key,
		 unsigned int *value_len, char **value);
bool_t map_first(struct plugin_state *state,
		 const char *domain, const char *map,
		 unsigned int *first_key_len, char **first_key,
		 unsigned int *first_value_len, char **first_value);
bool_t map_next(struct plugin_state *state,
		const char *domain, const char *map,
		unsigned int prev_len, const char *prev,
		unsigned int *next_key_len, char **next_key,
		unsigned int *next_value_len, char **next_value);
bool_t map_order(struct plugin_state *state,
		 const char *domain, const char *map,
		 unsigned int *order);
/* Functions to push data into maps. */
void map_data_clear_map(struct plugin_state *state,
			const char *domain_name, const char *map_name);
void map_data_unset_map(struct plugin_state *state,
			const char *domain_name, const char *map_name);
void map_data_set_map(struct plugin_state *state,
		      const char *domain_name, const char *map_name,
		      void *backend_data, void (*free_backend_data)(void *p));
void map_data_unset_entry_key(struct plugin_state *state,
			      const char *domain_name, const char *map_name,
			      unsigned int key_len, const char *key);
void map_data_unset_entry_id(struct plugin_state *state,
			     const char *domain_name, const char *map_name,
			     const char *id);
void map_data_set_entry(struct plugin_state *state,
			const char *domain_name, const char *map_name,
			const char *id, const char **related_ids,
			unsigned int key_len, char *key,
			unsigned int value_len, char *value);
bool_t map_data_check_entry(struct plugin_state *state,
			    const char *domain_name, const char *map_name,
			    const char *id);
bool_t map_data_foreach_entry_id(struct plugin_state *state, const char *id,
				 bool_t (*fn)(const char *domain,
					      const char *map,
					      const char *key,
					      unsigned int key_len,
					      const char *value,
					      unsigned int value_len,
					      const char *id, void *cbdata),
				 void *cbdata);
bool_t map_data_foreach_entry_related_id(struct plugin_state *state,
					 const char *related_id,
					 bool_t (*fn)(const char *domain,
						      const char *map,
						      const char *key,
						      unsigned int key_len,
						      const char *value,
						      unsigned int value_len,
						      const char *id,
						      void *cbdata),
					 void *cbdata);
bool_t map_data_foreach_map(struct plugin_state *state, const char *domain_name,
			    bool_t (*fn)(const char *domain,
			   		 const char *map,
					 void *backend_data,
					 void *cbdata),
			    void *cbdata);
void map_rdlock(void);
void map_wrlock(void);
void map_unlock(void);
#endif