#include "ecore_private.h"
#include "Ecore.h"
#include "Ecore_Data.h"

#define PRIME_TABLE_MAX 21
#define PRIME_MIN 17
#define PRIME_MAX 1677721

#define ECORE_HASH_CHAIN_MAX 3

#define ECORE_COMPUTE_HASH(hash, key) hash->hash_func(key) % \
					ecore_prime_table[hash->size];

#define ECORE_HASH_INCREASE(hash) ((hash && hash->size < PRIME_MAX) ? \
		(hash->nodes / ecore_prime_table[hash->size]) > \
		ECORE_HASH_CHAIN_MAX : FALSE)
#define ECORE_HASH_REDUCE(hash) ((hash && hash->size > PRIME_MIN) ? \
		(double)hash->nodes / (double)ecore_prime_table[hash->size-1] \
		< ((double)ECORE_HASH_CHAIN_MAX * 0.375) : FALSE)


/* Private hash manipulation functions */
static int _ecore_hash_add_node(Ecore_Hash *hash, Ecore_Hash_Node *node);
static Ecore_Hash_Node * _ecore_hash_get_node(Ecore_Hash *hash, void *key);
static int _ecore_hash_increase(Ecore_Hash *hash);
static int _ecore_hash_decrease(Ecore_Hash *hash);
inline int _ecore_hash_rehash(Ecore_Hash *hash, Ecore_List **old_table, int old_size);
static int _ecore_hash_bucket_destroy(Ecore_List *list, Ecore_Free_Cb keyd,
		Ecore_Free_Cb valued);
inline Ecore_Hash_Node * _ecore_hash_get_bucket(Ecore_Hash *hash, Ecore_List *bucket,
		void *key);

static Ecore_Hash_Node *_ecore_hash_node_new(void *key, void *value);
static int _ecore_hash_node_init(Ecore_Hash_Node *node, void *key, void *value);
static int _ecore_hash_node_destroy(Ecore_Hash_Node *node, Ecore_Free_Cb keyd,
		Ecore_Free_Cb valued);

/**
 * @defgroup Ecore_Data_Hash_ADT_Creation_Group Hash Creation Functions
 *
 * Functions that create hash tables.
 */

/**
 * Creates and initializes a new hash
 * @param hash_func The function for determining hash position.
 * @param compare   The function for comparing node keys.
 * @return @c NULL on error, a new hash on success.
 * @ingroup Ecore_Data_Hash_ADT_Creation_Group
 */
Ecore_Hash *ecore_hash_new(Ecore_Hash_Cb hash_func, Ecore_Compare_Cb compare)
{
	Ecore_Hash *new_hash = (Ecore_Hash *)malloc(sizeof(Ecore_Hash));
	if (!new_hash)
		return NULL;

	if (!ecore_hash_init(new_hash, hash_func, compare)) {
		FREE(new_hash);
		return NULL;
	}

	return new_hash;
}

/**
 * Initializes the given hash.
 * @param   hash       The given hash.
 * @param   hash_func  The function used for hashing node keys.
 * @param   compare    The function used for comparing node keys.
 * @return  @c TRUE on success, @c FALSE on an error.
 * @ingroup Ecore_Data_Hash_ADT_Creation_Group
 */
int ecore_hash_init(Ecore_Hash *hash, Ecore_Hash_Cb hash_func, Ecore_Compare_Cb compare)
{
	CHECK_PARAM_POINTER_RETURN("hash", hash, FALSE);

	memset(hash, 0, sizeof(Ecore_Hash));

	hash->hash_func = hash_func;
	hash->compare = compare;

	hash->buckets = (Ecore_List **)malloc(ecore_prime_table[0] *
			sizeof(Ecore_List *));
	memset(hash->buckets, 0, ecore_prime_table[0] * sizeof(Ecore_List *));

	ECORE_INIT_LOCKS(hash);

	return TRUE;
}

/**
 * @defgroup Ecore_Data_Hash_ADT_Destruction_Group Hash Destruction Functions
 *
 * Functions that destroy hash tables and their contents.
 */

/**
 * Sets the function to destroy the keys of the given hash.
 * @param   hash     The given hash.
 * @param   function The function used to free the node keys.
 * @return  @c TRUE on success, @c FALSE on error.
 * @ingroup Ecore_Data_Hash_ADT_Destruction_Group
 */
int ecore_hash_set_free_key(Ecore_Hash *hash, Ecore_Free_Cb function)
{
	CHECK_PARAM_POINTER_RETURN("hash", hash, FALSE);
	CHECK_PARAM_POINTER_RETURN("function", function, FALSE);

	ECORE_WRITE_LOCK(hash);
	hash->free_key = function;
	ECORE_WRITE_UNLOCK(hash);

	return TRUE;
}

/**
 * Sets the function to destroy the values in the given hash.
 * @param   hash     The given hash.
 * @param   function The function that will free the node values.
 * @return  @c TRUE on success, @c FALSE on error
 * @ingroup Ecore_Data_Hash_ADT_Destruction_Group
 */
int ecore_hash_set_free_value(Ecore_Hash *hash, Ecore_Free_Cb function)
{
	CHECK_PARAM_POINTER_RETURN("hash", hash, FALSE);
	CHECK_PARAM_POINTER_RETURN("function", function, FALSE);

	ECORE_WRITE_LOCK(hash);
	hash->free_value = function;
	ECORE_WRITE_UNLOCK(hash);

	return TRUE;
}

/**
 * @defgroup Ecore_Data_Hash_ADT_Data_Group Hash Data Functions
 *
 * Functions that set, access and delete values from the hash tables.
 */

/**
 * Sets a key-value pair in the given hash table.
 * @param   hash    The given hash table.
 * @param   key     The key.
 * @param   value   The value.
 * @return  @c TRUE if successful, @c FALSE if not.
 * @ingroup Ecore_Data_Hash_ADT_Data_Group
 */
int ecore_hash_set(Ecore_Hash *hash, void *key, void *value)
{
	int ret = FALSE;
	Ecore_Hash_Node *node;

	CHECK_PARAM_POINTER_RETURN("hash", hash, FALSE);

	ECORE_WRITE_LOCK(hash);
	node = _ecore_hash_get_node(hash, key);
	if (node)
		node->value = value;
	else {
		node = _ecore_hash_node_new(key, value);
		if (node)
			ret = _ecore_hash_add_node(hash, node);
	}
	ECORE_WRITE_UNLOCK(hash);

	return ret;
}

/**
 * Frees the hash table and the data contained inside it.
 * @param   hash The hash table to destroy.
 * @return  @c TRUE on success, @c FALSE on error.
 * @ingroup Ecore_Data_Hash_ADT_Destruction_Group
 */
void ecore_hash_destroy(Ecore_Hash *hash)
{
	unsigned int i = 0;

	CHECK_PARAM_POINTER("hash", hash);

	ECORE_WRITE_LOCK(hash);

	while (i < ecore_prime_table[hash->size]) {
		if (hash->buckets[i])
			_ecore_hash_bucket_destroy(hash->buckets[i],
					hash->free_key, hash->free_value);
		i++;
	}

	FREE(hash->buckets);

	ECORE_WRITE_UNLOCK(hash);
	ECORE_DESTROY_LOCKS(hash);

	FREE(hash);

	return;
}

/**
 * @defgroup Ecore_Data_Hash_ADT_Traverse_Group Hash Traverse Functions
 *
 * Functions that iterate through hash tables.
 */

/**
 * Runs the @p for_each_func function on each entry in the given hash.
 * @param   hash          The given hash.
 * @param   for_each_func The function that each entry is passed to.
 * @param		user_data			a pointer passed to calls of for_each_func
 * @return  TRUE on success, FALSE otherwise.
 * @ingroup Ecore_Data_Hash_ADT_Traverse_Group
 */
int ecore_hash_for_each_node(Ecore_Hash *hash, Ecore_For_Each for_each_func,
														 void *user_data)
{
	unsigned int i = 0;

	CHECK_PARAM_POINTER_RETURN("hash", hash, FALSE);
	CHECK_PARAM_POINTER_RETURN("for_each_func", for_each_func, FALSE);

	ECORE_READ_LOCK(hash);

	while (i < ecore_prime_table[hash->size]) {
		if (hash->buckets[i]) {
			Ecore_Hash_Node *node;

			ecore_list_goto_first(hash->buckets[i]);
			while ((node = ecore_list_next(hash->buckets[i]))) {
				for_each_func(node, user_data);
			}
		}
		i++;
	}

	ECORE_READ_UNLOCK(hash);

	return TRUE;
}

/**
 * Retrieves an ecore_list of all keys in the given hash.
 * @param   hash          The given hash.
 * @return  new ecore_list on success, NULL otherwise
 * @ingroup Ecore_Data_Hash_ADT_Traverse_Group
 */
Ecore_List *ecore_hash_keys(Ecore_Hash *hash)
{
	unsigned int i = 0;
	Ecore_List *keys;

	CHECK_PARAM_POINTER_RETURN("hash", hash, NULL);

	ECORE_READ_LOCK(hash);

	keys = ecore_list_new();

	while (i < ecore_prime_table[hash->size]) {
		if (hash->buckets[i]) {
			Ecore_Hash_Node *node;

			ecore_list_goto_first(hash->buckets[i]);
			while ((node = ecore_list_next(hash->buckets[i]))) {
				ecore_list_append(keys, node->key);
			}
		}
		i++;
	}

	ecore_list_goto_first(keys);

	ECORE_READ_UNLOCK(hash);

	return keys;
}

/**
 * Prints the distribution of the given hash table for graphing.
 * @param hash The given hash table.
 */
void
ecore_hash_dump_graph(Ecore_Hash *hash)
{
	unsigned int i;

	for (i = 0; i < ecore_prime_table[hash->size]; i++)
		if (hash->buckets[i])
			printf("%d\t%u\n", i, ecore_list_nodes(hash->buckets[i]));
		else
			printf("%d\t0\n", i);
}

static int
_ecore_hash_bucket_destroy(Ecore_List *list, Ecore_Free_Cb keyd, Ecore_Free_Cb valued)
{
	Ecore_Hash_Node *node;

	CHECK_PARAM_POINTER_RETURN("list", list, FALSE);

	while ((node = ecore_list_remove_first(list)) != NULL)
		_ecore_hash_node_destroy(node, keyd, valued);

	ecore_list_destroy(list);

	return TRUE;
}

/*
 * @brief Add the node to the hash table
 * @param hash: the hash table to add the key
 * @param node: the node to add to the hash table
 * @return Returns FALSE on error, TRUE on success
 */
static int
_ecore_hash_add_node(Ecore_Hash *hash, Ecore_Hash_Node *node)
{
	unsigned int hash_val;
		
	CHECK_PARAM_POINTER_RETURN("hash", hash, FALSE);
	CHECK_PARAM_POINTER_RETURN("node", node, FALSE);

	/* Check to see if the hash needs to be resized */
	if (ECORE_HASH_INCREASE(hash))
		_ecore_hash_increase(hash);

	/* Compute the position in the table */
	if (!hash->hash_func)
		hash_val = (unsigned int)node->key % ecore_prime_table[hash->size];
	else
		hash_val = ECORE_COMPUTE_HASH(hash, node->key);

	/* Create the list if it's not already present */
	if (!hash->buckets[hash_val])
		hash->buckets[hash_val] = ecore_list_new();

	/* Append the node to the list at the index position */
	if (!ecore_list_prepend(hash->buckets[hash_val], node))
		return FALSE;
	hash->nodes++;

	return TRUE;
}

/**
 * Retrieves the value associated with the given key from the given hash
 * table.
 * @param   hash The given hash table.
 * @param   key  The key to search for.
 * @return  The value corresponding to key on success, @c NULL otherwise.
 * @ingroup Ecore_Data_Hash_ADT_Data_Group
 */
void *ecore_hash_get(Ecore_Hash *hash, void *key)
{
	void *data;
	Ecore_Hash_Node *node;

	CHECK_PARAM_POINTER_RETURN("hash", hash, NULL);

	node = _ecore_hash_get_node(hash, key);
	if (!node)
		return NULL;

	ECORE_READ_LOCK(node);
	data = node->value;
	ECORE_READ_UNLOCK(node);

	return data;
}


/**
 * Removes the value associated with the given key in the given hash
 * table.
 * @param   hash The given hash table.
 * @param   key  The key to search for.
 * @return  The value corresponding to the key on success.  @c NULL is
 *          returned if there is an error.
 * @ingroup Ecore_Data_Hash_ADT_Data_Group
 */
void *ecore_hash_remove(Ecore_Hash *hash, void *key)
{
	Ecore_Hash_Node *node = NULL;
	Ecore_List *list;
	unsigned int hash_val;
	void *ret = NULL;

	CHECK_PARAM_POINTER_RETURN("hash", hash, NULL);

	ECORE_WRITE_LOCK(hash);

	/* Compute the position in the table */
	if (!hash->hash_func)
		hash_val = (unsigned int )key % ecore_prime_table[hash->size];
	else
		hash_val = ECORE_COMPUTE_HASH(hash, key);

	/*
	 * If their is a list that could possibly hold the key/value pair
	 * traverse it and remove the hash node.
	 */
	if (hash->buckets[hash_val]) {
		list = hash->buckets[hash_val];
		ecore_list_goto_first(list);

		/*
		 * Traverse the list to find the specified key
		 */
		if (hash->compare) {
			while ((node = ecore_list_current(list)) &&
					hash->compare(node->key, key) != 0)
				ecore_list_next(list);
		}
		else {
			while ((node = ecore_list_current(list)) &&
					node->key != key)
				ecore_list_next(list);
		}

		if (node) {
			ecore_list_remove(list);
			ret = node->value;
			node->value = NULL;
			_ecore_hash_node_destroy(node, hash->free_key,
						 NULL);
		}
	}

	if (ECORE_HASH_REDUCE(hash))
		_ecore_hash_decrease(hash);

	ECORE_WRITE_UNLOCK(hash);

	return ret;
}

/*
 * @brief Retrieve the node associated with key
 * @param hash: the hash table to search for the key
 * @param key: the key to search for in the hash table
 * @return Returns NULL on error, node corresponding to key on success
 */
static Ecore_Hash_Node *
_ecore_hash_get_node(Ecore_Hash *hash, void *key)
{
	unsigned int hash_val;
	Ecore_Hash_Node *node = NULL;

	CHECK_PARAM_POINTER_RETURN("hash", hash, NULL);

	ECORE_READ_LOCK(hash);

	/* Compute the position in the table */
	if (!hash->hash_func)
		hash_val = (unsigned int )key % ecore_prime_table[hash->size];
	else
		hash_val = ECORE_COMPUTE_HASH(hash, key);

	/* Grab the bucket at the specified position */
	if (hash->buckets[hash_val])
		node = _ecore_hash_get_bucket(hash, hash->buckets[hash_val], key);

	ECORE_READ_UNLOCK(hash);

	return node;
}

/*
 * @brief Search the hash bucket for a specified key
 * @param hash: the hash table to retrieve the comparison function
 * @param bucket: the list to search for the key
 * @param key: the key to search for in the list
 * @return Returns NULL on error or not found, the found node on success
 */
inline Ecore_Hash_Node *
_ecore_hash_get_bucket(Ecore_Hash *hash, Ecore_List *bucket, void *key)
{
	Ecore_Hash_Node *node = NULL;

	ECORE_READ_LOCK(hash);
	ecore_list_goto_first(bucket);

	/*
	 * Traverse the list to find the desired node, if the node is in the
	 * list, then return the node.
	 */
	if (hash->compare) {
		while ((node = ecore_list_next(bucket)) != NULL) {
			ECORE_READ_LOCK(node);
			if (hash->compare(node->key, key) == 0) {
				ECORE_READ_UNLOCK(node);
				ECORE_READ_UNLOCK(hash);
				return node;
			}
			ECORE_READ_UNLOCK(node);
		}
	}
	else {
		while ((node = ecore_list_next(bucket)) != NULL) {
			ECORE_READ_LOCK(node);
			if (node->key == key) {
				ECORE_READ_UNLOCK(node);
				ECORE_READ_UNLOCK(hash);
				return node;
			}
			ECORE_READ_UNLOCK(node);
		}
	}
	ECORE_READ_UNLOCK(hash);

	return NULL;
}

/*
 * @brief Increase the size of the hash table by approx.  2 * current size
 * @param hash: the hash table to increase the size of
 * @return Returns TRUE on success, FALSE on error
 */
static int
_ecore_hash_increase(Ecore_Hash *hash)
{
	void *old;

	CHECK_PARAM_POINTER_RETURN("hash", hash, FALSE);

	/* Max size reached so return FALSE */
	if (hash->size == PRIME_TABLE_MAX)
		return FALSE;

	/*
	 * Increase the size of the hash and save a pointer to the old data
	 */
	hash->size++;
	old = hash->buckets;

	/*
	 * Allocate a new bucket area, of the new larger size
	 */
	hash->buckets = (Ecore_List **)calloc(ecore_prime_table[hash->size],
			sizeof(Ecore_List *));

	/*
	 * Make sure the allocation succeeded, if not replace the old data and
	 * return a failure.
	 */
	if (!hash->buckets) {
		hash->buckets = old;
		hash->size--;
		return FALSE;
	}
	hash->nodes = 0;

	/*
	 * Now move all of the old data into the new bucket area
	 */
	if (_ecore_hash_rehash(hash, old, hash->size - 1)) {
		FREE(old);
		return TRUE;
	}

	/*
	 * Free the old buckets regardless of success.
	 */
	FREE(old);

	return FALSE;
}

/*
 * @brief Decrease the size of the hash table by < 1/2 * current size
 * @param hash: the hash table to decrease the size of
 * @return Returns TRUE on success, FALSE on error
 */
static int
_ecore_hash_decrease(Ecore_Hash *hash)
{
	Ecore_List **old;

	CHECK_PARAM_POINTER_RETURN("hash", hash, FALSE);

	if (ecore_prime_table[hash->size] == PRIME_MIN)
		return FALSE;

	/*
	 * Decrease the hash size and store a pointer to the old data
	 */
	hash->size--;
	old = hash->buckets;

	/*
	 * Allocate a new area to store the data
	 */
	hash->buckets = (Ecore_List **)malloc(ecore_prime_table[hash->size] *
			sizeof(Ecore_List *));

	/*
	 * Make sure allocation succeeded otherwise rreturn to the previous
	 * state
	 */
	if (!hash->buckets) {
		hash->buckets = old;
		hash->size++;
		return FALSE;
	}

	/*
	 * Zero out the new area
	 */
	memset(hash->buckets, 0, ecore_prime_table[hash->size]
			* sizeof(Ecore_List *));
	hash->nodes = 0;

	if (_ecore_hash_rehash(hash, old, hash->size - 1)) {
		FREE(old);
		return TRUE;
	}

	return FALSE;
}

/*
 * @brief Rehash the nodes of a table into the hash table
 * @param hash: the hash to place the nodes of the table
 * @param table: the table to remove the nodes from and place in hash
 * @return Returns TRUE on success, FALSE on success
 */
inline int
_ecore_hash_rehash(Ecore_Hash *hash, Ecore_List **old_table, int old_size)
{
	unsigned int i;
	Ecore_Hash_Node *node;
	Ecore_List *old;

	CHECK_PARAM_POINTER_RETURN("hash", hash, FALSE);
	CHECK_PARAM_POINTER_RETURN("old_table", old_table, FALSE);

	for (i = 0; i < ecore_prime_table[old_size]; i++) {
		/* Hash into a new list to avoid loops of rehashing the same
		 * nodes */
		old = old_table[i];
		old_table[i] = NULL;

		/* Loop through re-adding each node to the hash table */
		while (old && (node = ecore_list_remove_last(old))) {
			_ecore_hash_add_node(hash, node);
		}

		/* Now free up the old list space */
		if (old)
			ecore_list_destroy(old);
	}

	return TRUE;
}

/*
 * @brief Create a new hash node for key and value storage
 * @param key: the key for this node
 * @param value: the value that the key references
 * @return Returns NULL on error, a new hash node on success
 */
static Ecore_Hash_Node *
_ecore_hash_node_new(void *key, void *value)
{
	Ecore_Hash_Node *node;

	node = (Ecore_Hash_Node *)malloc(sizeof(Ecore_Hash_Node));
	if (!node)
		return NULL;

	if (!_ecore_hash_node_init(node, key, value)) {
		FREE(node);
		return NULL;
	}

	return node;
}

/*
 * @brief Initialize a hash node to some sane default values
 * @param node: the node to set the values
 * @param key: the key to reference this node
 * @param value: the value that key refers to
 * @return Returns TRUE on success, FALSE on error
 */
static int
_ecore_hash_node_init(Ecore_Hash_Node *node, void *key, void *value)
{
	CHECK_PARAM_POINTER_RETURN("node", node, FALSE);

	ECORE_INIT_LOCKS(node);
	node->key = key;
	node->value = value;

	return TRUE;
}

/*
 * @brief Destroy a node and call the specified callbacks to free data
 * @param node: the node to be destroyed
 * @param keyd: the function to free the key
 * @param valued: the function  to free the value
 * @return Returns TRUE on success, FALSE on error
 */
static int
_ecore_hash_node_destroy(Ecore_Hash_Node *node, Ecore_Free_Cb keyd,
		Ecore_Free_Cb valued)
{
	CHECK_PARAM_POINTER_RETURN("node", node, FALSE);

	if (keyd)
		keyd(node->key);

	if (valued)
		valued(node->value);

	FREE(node);

	return TRUE;
}