hashtable.h

Go to the documentation of this file.

#ifndef _CP_HASHTABLE_H
#define _CP_HASHTABLE_H

/*
 * hash table implementation
 */

#include "common.h"

__BEGIN_DECLS

#include "collection.h"

/*
 * cp_hashtable interface for members of mapping collections.
 */

#include "config.h"

#define HASH_SEED 1000000001L

#ifndef CP_HASHTABLE_DEFAULT_MIN_FILL_FACTOR
#define CP_HASHTABLE_DEFAULT_MIN_FILL_FACTOR   5
#endif

#ifndef CP_HASHTABLE_DEFAULT_MAX_FILL_FACTOR
#define CP_HASHTABLE_DEFAULT_MAX_FILL_FACTOR  70
#endif

/* ----------------------------------------------------------------- 
 * Function prototypes
 * ----------------------------------------------------------------- */
typedef unsigned long (*cp_hashfunction)(void *);


/* ------------------------------------------------------------------------ 
 * hash function prototypes for primitives and cp_strings
 * ------------------------------------------------------------------------ */


CPROPS_DLL 
unsigned long cp_hash_int(void *key);


CPROPS_DLL 
int cp_hash_compare_int(void *key1, void *key2);

CPROPS_DLL 
unsigned long cp_hash_long(void *key);

CPROPS_DLL 
int cp_hash_compare_long(void *key1, void *key2);

CPROPS_DLL 
unsigned long cp_hash_addr(void *addr);

CPROPS_DLL 
int cp_hash_compare_addr(void *key1, void *key2);

CPROPS_DLL 
unsigned long cp_hash_string(void *key);

CPROPS_DLL 
unsigned long cp_hash_istring(void *key);


CPROPS_DLL 
void *cp_hash_copy_string(void *element);

CPROPS_DLL 
int cp_hash_compare_string(void *key1, void *key2);


CPROPS_DLL 
int cp_hash_compare_istring(void *key1, void *key2);



typedef CPROPS_DLL struct _cp_hashtable_entry 
{
    void *key;                   
    void *value;                 
    unsigned long hashcode;      
    struct _cp_hashtable_entry *next; 
} cp_hashtable_entry;

typedef CPROPS_DLL struct _cp_hashtable
{
    cp_hashtable_entry **table;     
    long table_size;                
    unsigned long items;            
    int mode;                       
    cp_hashfunction   hash_fn;      
    cp_compare_fn     compare_fn;   
    cp_copy_fn        copy_key;     
    cp_copy_fn        copy_value;   
    cp_destructor_fn  free_key;
    cp_destructor_fn  free_value;

    cp_lock           *lock;        
    cp_thread         txowner;      
    int               txtype;       
    int min_size;                   
    int fill_factor_min;            
    int fill_factor_max;            
    cp_hashtable_entry **resize_table; 
    int resizing;                   
    unsigned long resize_len;       
    cp_thread resize_thread;        
    cp_mutex *resize_lock;          
} cp_hashtable;


CPROPS_DLL 
cp_hashtable *
    cp_hashtable_create(unsigned long size_hint, 
                        cp_hashfunction hashfn, 
                        cp_compare_fn compare_fn);

#define cp_hashtable_create_by_mode(mode, size_hint, cp_hashfn, compare_fn) \
        cp_hashtable_create_by_option((mode), (size_hint), (cp_hashfn), (compare_fn), NULL, NULL, NULL, NULL)

CPROPS_DLL 
cp_hashtable *
    cp_hashtable_create_copy_mode(unsigned long size_hint, 
                                  cp_hashfunction hash_fn, 
                                  cp_compare_fn compare_fn, 
                                  cp_copy_fn copy_key, 
                                  cp_destructor_fn free_key,
                                  cp_copy_fn copy_value,
                                  cp_destructor_fn free_value);    

CPROPS_DLL 
cp_hashtable *
    cp_hashtable_create_by_option(int mode, unsigned long size_hint, 
                                  cp_hashfunction hash_fn, 
                                  cp_compare_fn compare_fn, 
                                  cp_copy_fn copy_key, 
                                  cp_destructor_fn free_key,
                                  cp_copy_fn copy_value,
                                  cp_destructor_fn free_value);

CPROPS_DLL 
void cp_hashtable_destroy(cp_hashtable *table);

CPROPS_DLL 
void cp_hashtable_destroy_shallow(cp_hashtable *table);

CPROPS_DLL 
void cp_hashtable_destroy_deep(cp_hashtable *table);


CPROPS_DLL 
void cp_hashtable_destroy_custom(cp_hashtable *table, cp_destructor_fn dk, cp_destructor_fn dv);

CPROPS_DLL 
int cp_hashtable_lock(cp_hashtable *table, int type);

CPROPS_DLL 
int cp_hashtable_unlock(cp_hashtable *table);

#define cp_hashtable_rdlock(table) cp_hashtable_lock((table), COLLECTION_LOCK_READ)

#define cp_hashtable_wrlock(table) cp_hashtable_lock((table), COLLECTION_LOCK_WRITE)

CPROPS_DLL 
int cp_hashtable_get_mode(cp_hashtable *table);

CPROPS_DLL 
int cp_hashtable_set_mode(cp_hashtable *table, int mode);


CPROPS_DLL 
int cp_hashtable_unset_mode(cp_hashtable *table, int mode);


CPROPS_DLL 
int cp_hashtable_set_min_size(cp_hashtable *table, int min_size);

CPROPS_DLL 
int cp_hashtable_set_max_fill_factor(cp_hashtable *table, int fill_factor);

CPROPS_DLL 
int cp_hashtable_set_min_fill_factor(cp_hashtable *table, int fill_factor);

CPROPS_DLL 
void *cp_hashtable_get(cp_hashtable *table, void *key);

CPROPS_DLL 
void *cp_hashtable_get_by_option(cp_hashtable *table, void *key, int mode);

CPROPS_DLL 
void *cp_hashtable_put_by_option(cp_hashtable *table, void *key, void *value, int mode);

CPROPS_DLL 
void *cp_hashtable_put(cp_hashtable *table, void *key, void *value);

CPROPS_DLL 
void *cp_hashtable_put_safe(cp_hashtable *table, void *key, void *value);

CPROPS_DLL 
void *cp_hashtable_put_copy(cp_hashtable *table, void *key, void *value);

CPROPS_DLL 
void *cp_hashtable_remove(cp_hashtable *table, void *key);

CPROPS_DLL 
int cp_hashtable_remove_all(cp_hashtable *table);

CPROPS_DLL 
int cp_hashtable_remove_deep(cp_hashtable *table, void *key);

CPROPS_DLL 
int cp_hashtable_contains(cp_hashtable *table, void *key);

CPROPS_DLL 
void **cp_hashtable_get_keys(cp_hashtable *table);

CPROPS_DLL 
void **cp_hashtable_get_values(cp_hashtable *table);

CPROPS_DLL 
unsigned long cp_hashtable_count(cp_hashtable *table);

#define cp_hashtable_is_empty(table) (cp_hashtable_count(table) == 0)

CPROPS_DLL 
unsigned long cp_hashtable_choose_size(unsigned long size_request);

__END_DECLS
#endif

---