hashlist.h

Go to the documentation of this file.

#ifndef _CP_HASHLIST_H
#define _CP_HASHLIST_H

/* ----------------------------------------------------------------- */

#include "common.h"

__BEGIN_DECLS

#include "config.h"

#include "collection.h"
#include "hashtable.h"

/*************/

typedef CPROPS_DLL struct _cp_hashlist_entry
{
    void *key;                         
    void *value;                       
    struct _cp_hashlist_entry *next;      
    struct _cp_hashlist_entry *prev;      
    struct _cp_hashlist_entry *bucket;    
} cp_hashlist_entry;


typedef CPROPS_DLL struct _cp_hashlist
{
    cp_hashlist_entry **table;    
    cp_hashlist_entry *head;      
    cp_hashlist_entry *tail;      
    unsigned long table_size;     
    unsigned long items;          
    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;

    int mode;                     
    cp_lock *lock;                
    cp_thread txowner;            
    int txtype;                   
    unsigned long min_size;
    int fill_factor_min;          
    int fill_factor_max;          
#if (CP_DEBUGLEVEL >= 2)
    cp_thread dtr_caller;
#endif
} cp_hashlist;

typedef CPROPS_DLL struct _cp_hashlist_iterator
{
    cp_hashlist *list;        
    cp_hashlist_entry **pos;   
    int lock_type;           
} cp_hashlist_iterator;


/*
 * Removes the entry with matching key and destroys it. 
 *
 * @param list the object
 * @param key  Key which is searched.
 * @param mode locking mode
 * @retval value that was stored in the entry.
 * @retval NULL if key was not found
 */
CPROPS_DLL 
void *cp_hashlist_remove_by_option(cp_hashlist *list, void *key, int mode);

CPROPS_DLL 
void *cp_hashlist_remove_head_by_option(cp_hashlist *list, int mode);

CPROPS_DLL 
void *cp_hashlist_remove_tail_by_option(cp_hashlist *list, int mode);

/*************/

#define cp_hashlist_create(size_hint, hash_fn, compare_fn) \
        cp_hashlist_create_by_option(0, (size_hint), \
                                     (hash_fn), (compare_fn), \
                                     NULL, NULL, NULL, NULL)

CPROPS_DLL 
cp_hashlist *cp_hashlist_create_by_mode(int mode, 
                                        unsigned long size_hint, 
                                        cp_hashfunction hash_fn, 
                                        cp_compare_fn compare_fn);

CPROPS_DLL 
cp_hashlist *
    cp_hashlist_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_hashlist_destroy(cp_hashlist *);

CPROPS_DLL 
void cp_hashlist_destroy_deep(cp_hashlist *);

CPROPS_DLL 
void cp_hashlist_destroy_by_option(cp_hashlist *list, int mode);

CPROPS_DLL 
void cp_hashlist_destroy_custom(cp_hashlist *list, 
                                cp_destructor_fn dk, 
                                cp_destructor_fn dv);

CPROPS_DLL 
int cp_hashlist_callback(cp_hashlist *list, 
                         int (*cb)(void *key, void *value, void *id),
                         void *id);

CPROPS_DLL 
int cp_hashlist_get_mode(cp_hashlist *list);

CPROPS_DLL 
int cp_hashlist_set_mode(cp_hashlist *list, int mode);

CPROPS_DLL 
int cp_hashlist_unset_mode(cp_hashlist *list, int mode);


CPROPS_DLL 
int cp_hashlist_set_min_size(cp_hashlist *list, unsigned long min_size);

CPROPS_DLL 
int cp_hashlist_set_max_fill_factor(cp_hashlist *list, int fill_factor);

CPROPS_DLL 
int cp_hashlist_set_min_fill_factor(cp_hashlist *list, int fill_factor);


/* **************************************************************************
 *                                                                          *
 *                            iterator functions                            *
 *                                                                          *
 ************************************************************************** */

CPROPS_DLL 
cp_hashlist_iterator *cp_hashlist_create_iterator(cp_hashlist *list, int lock_mode);

CPROPS_DLL 
int cp_hashlist_iterator_head(cp_hashlist_iterator *iterator);
//int cp_hashlist_iterator_head(cp_hashlist_iterator *iterator, cp_hashlist *l, int lock_mode);

CPROPS_DLL 
int cp_hashlist_iterator_init(cp_hashlist_iterator *iterator, 
                              cp_hashlist *list, int type);
CPROPS_DLL 
int cp_hashlist_iterator_init_tail(cp_hashlist_iterator *iterator, cp_hashlist *l, int lock_mode);

CPROPS_DLL 
int cp_hashlist_iterator_tail(cp_hashlist_iterator *iterator);

CPROPS_DLL 
int cp_hashlist_iterator_to_key(cp_hashlist_iterator *iterator, void *key);

CPROPS_DLL 
int cp_hashlist_iterator_destroy(cp_hashlist_iterator *iterator);

CPROPS_DLL 
int cp_hashlist_iterator_release(cp_hashlist_iterator *iterator);


CPROPS_DLL 
cp_hashlist_entry *cp_hashlist_iterator_next(cp_hashlist_iterator *iterator);

CPROPS_DLL 
void *cp_hashlist_iterator_next_key(cp_hashlist_iterator *iterator);

CPROPS_DLL 
void *cp_hashlist_iterator_next_value(cp_hashlist_iterator *iterator);

CPROPS_DLL 
cp_hashlist_entry *cp_hashlist_iterator_prev(cp_hashlist_iterator *iterator);

CPROPS_DLL 
void *cp_hashlist_iterator_prev_key(cp_hashlist_iterator *iterator);

CPROPS_DLL 
void *cp_hashlist_iterator_prev_value(cp_hashlist_iterator *iterator);

CPROPS_DLL 
cp_hashlist_entry *cp_hashlist_iterator_curr(cp_hashlist_iterator *iterator);

CPROPS_DLL 
void *cp_hashlist_iterator_curr_key(cp_hashlist_iterator *iterator);

CPROPS_DLL 
void *cp_hashlist_iterator_curr_value(cp_hashlist_iterator *iterator);


CPROPS_DLL 
cp_hashlist_entry *cp_hashlist_iterator_insert(cp_hashlist_iterator *iterator, 
                                               void *key, 
                                               void *value);
CPROPS_DLL 
cp_hashlist_entry *cp_hashlist_iterator_append(cp_hashlist_iterator *iterator, 
                                               void *key,
                                               void *value);

CPROPS_DLL 
void *cp_hashlist_iterator_remove(cp_hashlist_iterator *iterator);


/* ------------------------ end iterator functions ------------------------ */



CPROPS_DLL 
unsigned long cp_hashlist_item_count(cp_hashlist *);

CPROPS_DLL 
void *cp_hashlist_entry_get_key(cp_hashlist_entry *entry);

CPROPS_DLL 
void *cp_hashlist_entry_get_value(cp_hashlist_entry *entry);

CPROPS_DLL 
void *cp_hashlist_insert(cp_hashlist *list, void *key, void *value);

CPROPS_DLL 
void *cp_hashlist_insert_by_option(cp_hashlist *list, void *key, void *item, int mode);

CPROPS_DLL 
void *cp_hashlist_append(cp_hashlist *list, void *key, void *value);

CPROPS_DLL 
void *cp_hashlist_append_by_option(cp_hashlist *, void *key, void *value, int mode);

CPROPS_DLL 
void *cp_hashlist_get(cp_hashlist *, void *key);

CPROPS_DLL 
int cp_hashlist_contains(cp_hashlist *list, void *key);

CPROPS_DLL 
void *cp_hashlist_get_head(cp_hashlist *);

CPROPS_DLL 
void *cp_hashlist_get_tail(cp_hashlist *);

CPROPS_DLL 
void *cp_hashlist_remove(cp_hashlist *list, void *key);

CPROPS_DLL 
void *cp_hashlist_remove_deep(cp_hashlist *list, void *key);


CPROPS_DLL 
void *cp_hashlist_remove_by_option(cp_hashlist *list, void *key, int mode);

CPROPS_DLL 
void *cp_hashlist_remove_head(cp_hashlist *list);

CPROPS_DLL 
void *cp_hashlist_remove_tail(cp_hashlist *list);

/*
 * Get the next entry. 
 *
 * @return value of the next element
 */
//CPROPS_DLL 
//void *cp_hashlist_get_next(cp_hashlist *list);

CPROPS_DLL 
int cp_hashlist_is_empty(cp_hashlist *list); //  { return cp_hashlist_item_count(list) == 0; }

CPROPS_DLL 
int cp_hashlist_lock(cp_hashlist *list, int type);

CPROPS_DLL 
int cp_hashlist_unlock(cp_hashlist *list);

#define cp_hashlist_rdlock(list) cp_hashlist_lock((list), COLLECTION_LOCK_READ)

#define cp_hashlist_wrlock(list) cp_hashlist_lock((list), COLLECTION_LOCK_WRITE)

__END_DECLS

#endif

---