hash.h

/*
Copyright (c) 1991-2002, The Numerical ALgorithms Group Ltd.
All rights reserved.
  Copyright (C) 2007-2010, Gabriel Dos Reis.
  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 Numerical ALgorithms Group Ltd. 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.
*/

#ifndef OPENAXIOM_HASH_INCLUDED
#define OPENAXIOM_HASH_INCLUDED

struct HashEntry {
   const char *key;             /* pointer to key data */
   char *data;			/* Pointer to entry */
   struct HashEntry *next;	/* Link to next entry */
};

typedef int (*EqualFunction)(const void*, const void*);
typedef int (*HashcodeFunction)(const void*,int);
typedef void (*MappableFunction) (const void*);
typedef void (*FreeFunction) (void *);
struct HashTable {
  HashEntry **table;		/* the actual table */
  int size;			/* size of table */
  int num_entries;		/* number of elements in a hash table */
  EqualFunction equal;		/* equality predicate for keys */
  HashcodeFunction hash_code;	/* create hash code for a key */
};

extern char* alloc_string(const char*);
extern HashEntry* hash_copy_entry(HashEntry*);
extern HashTable* hash_copy_table(HashTable*);
extern void hash_delete(HashTable*, const char*);
extern char* hash_find(HashTable*, const char*);
extern void hash_init(HashTable*, int, EqualFunction, HashcodeFunction);
extern void free_hash(HashTable*, FreeFunction);
extern void hash_insert(HashTable*, char*, const char*);
extern void hash_map(HashTable*, MappableFunction func);
extern char* hash_replace(HashTable*, char*, const char*);
extern int string_equal(const char*, const char*);
extern int string_hash(const char*, int size);

#endif  /* OPENAXIOM_HASH_INCLUDED */