/*

Copyright (c) 2005, Simon Howard
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions 
are met:

 * Redistributions of source code must retain the above copyright 
   notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright 
   notice, this list of conditions and the following disclaimer in 
   the documentation and/or other materials provided with the 
   distribution.
 * Neither the name of the C Algorithms project nor the names of its 
   contributors may be used to endorse or promote products derived 
   from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.

 *ALSO:   TI modifications made to support binary data keys
*
 *  Copyright (c) Texas Instruments Incorporated 2010-2011
*/

/* Trie: fast mapping of strings to values */

#include <stdlib.h>
#include <string.h>

#include "trie.h"

typedef struct _TrieNode TrieNode;

struct _TrieNode {
	void *data;
	unsigned int use_count;
	TrieNode *next[256];
};

struct _Trie {
	TrieNode *root_node;
};

static void trie_free_node(TrieNode *node)
{
	int i;

	if (node == NULL)
		return;
	
	/* First, free all subnodes */

	for (i=0; i<256; ++i) {
		trie_free_node(node->next[i]);
	}

	/* Free this node */

	free(node);
}

Trie *trie_new(void)
{
	Trie *new_trie;

	new_trie = (Trie *) malloc(sizeof(Trie));
	new_trie->root_node = NULL;

	return new_trie;
}

void trie_free(Trie *trie)
{
	/* Free the subnode, and all others by implication */

	trie_free_node(trie->root_node);

	/* Free the trie */

	free(trie);
}

void trie_insert(Trie *trie, char *key, int keylen, void *value)
{
	TrieNode **rover;
	TrieNode *node;
	unsigned char *p;
	unsigned char c;
	int k;

	/* Cannot insert NULL values */

	if (value == NULL) {
		return;
	}

	/* Search down the trie until we reach the end of string,
	 * creating nodes as necessary */

	rover = &trie->root_node;
	p = (unsigned char *) key;

	for (k=0;;) {

		node = *rover;

		if (node == NULL) {
			
			/* Node does not exist, so create it */

			node = (TrieNode *) malloc(sizeof(TrieNode));
			memset(node, 0, sizeof(TrieNode));

			/* Link in to the trie */

			*rover = node;
		}

		/* One more use of this node */

		++node->use_count;

		/* Current character */

		c = *p;

		/* Reached the end of string?  If so, we're finished. */

		if (k>=keylen) {

			/* Set the data at the node we have reached */

			node->data = value;

			break;
		}

		/* Advance to the next node in the chain */

		rover = &node->next[c];
		++p; 
		k+=1;
	}
}

void trie_remove(Trie *trie, char *key, int keylen)
{
	TrieNode *node;
	TrieNode *next;
	TrieNode **last_next_ptr;
	unsigned char *p;
	unsigned char c;
	int k=0;
	
	/* First, search down to the ending node so that the data can
	 * be removed. */

	/* Search down the trie until the end of string is reached */

	node = trie->root_node;

	for (p=(unsigned char *) key, k=0; k<keylen; ++p, k+=1) {

		if (node == NULL) {
			/* Not found in the tree. Return. */

			return;
		}

		/* Jump to the next node */

		c = *p;
		node = node->next[c];
	}

	/* Remove the data at this node */

	node->data = NULL;

	/* Now traverse the tree again as before, decrementing the use
	 * count of each node.  Free back nodes as necessary. */

	node = trie->root_node;
	last_next_ptr = &trie->root_node;
	p = key;

	for (k=0;;k++) {

		/* Find the next node */
		
		c = *p;
		next = node->next[c];

		/* Free this node if necessary */

		--node->use_count;

		if (node->use_count <= 0) {
			free(node);

			/* Set the "next" pointer on the previous node to NULL,
			 * to unlink the free'd node from the tree.  This only
			 * needs to be done once in a remove.  After the first
			 * unlink, all further nodes are also going to be
			 * free'd. */

			if (last_next_ptr != NULL) {
				*last_next_ptr = NULL;
				last_next_ptr = NULL;
			}
		}
		
		/* Go to the next character or finish */

		if (k>=keylen) {
			break;
		} else {
			++p;
		}

		/* If necessary, save the location of the "next" pointer
		 * so that it may be set to NULL on the next iteration if
		 * the next node visited is freed. */

		if (last_next_ptr != NULL) {
			last_next_ptr = &node->next[c];
		}
		
		/* Jump to the next node */

		node = next;
	}
}

void *trie_lookup(Trie *trie, char *key, int keylen)
{
	TrieNode *node;
	unsigned char *p;
	unsigned char c;
	int k=0;

	/* Search down the trie until the end of string is found */
	
	node = trie->root_node;
	p = (unsigned char *) key;

	while (k<keylen ) {
		if (node == NULL) {
			/* Not found - reached end of branch */

			return NULL;
		}

		/* Advance to the next node in the chain, next character */

		c = *p;
		node = node->next[c];
		++p;
		k+=1;
	}
        /* bug! */
        
	return (node ? node->data : NULL);

}

int trie_num_entries(Trie *trie)
{
	/* To find the number of entries, simply look at the use count
	 * of the root node. */

	if (trie->root_node == NULL) {
		return 0;
	} else {
		return trie->root_node->use_count;
	}
}

//#define TEST
#ifdef TEST
main()
{
Trie * p_trie;
char * p_res;
p_trie = trie_new();
if (!p_trie) {printf("trie alloc failed\n"); exit(1);}

trie_insert(p_trie,"key1","this is key 1");
trie_insert(p_trie,"key12","this is key 2");
trie_insert(p_trie,"key3","this is key 3");
trie_insert(p_trie,"key4","this is key 4");

p_res= trie_lookup(p_trie,"key1");
printf("lookup %s = %s\n", "key1", p_res ?  p_res : "not found");

p_res= trie_lookup(p_trie,"key12");
printf("lookup %s = %s\n", "key2", p_res ?  p_res : "not found");

p_res= trie_lookup(p_trie,"key3");
printf("lookup %s = %s\n", "key3", p_res ?  p_res : "not found");

p_res= trie_lookup(p_trie,"key4");
printf("lookup %s = %s\n", "key4", p_res ?  p_res : "not found");

p_res= trie_lookup(p_trie,"key5");
printf("lookup %s = %s\n", "key5", p_res ?  p_res : "not found");

p_res= trie_lookup(p_trie,"k5");
printf("lookup %s = %s\n", "k5", p_res ?  p_res : "not found");

trie_free(p_trie);

}
#endif