assocarray.h

Go to the documentation of this file.

/***************************************************************************
    begin........: May 2012
    copyright....: Sebastian Fedrau
    email........: sebastian.fedrau@gmail.com
 ***************************************************************************/
 
/***************************************************************************
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License v3 as published by
    the Free Software Foundation.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    General Public License v3 for more details.
 ***************************************************************************/
#ifndef ASSOCARRAY_H
#define ASSOCARRAY_H
 
#include <stdbool.h>
#include <sys/types.h>
 
#include "datatypes.h"
 
#define ASSOC_ARRAY_MAX_SIZE (SSIZE_MAX / sizeof(void *))
 
typedef struct _AssocArray
{
    CompareFunc compare_keys;
    void **keys;
    void **values;
    FreeFunc free_key;
    FreeFunc free_value;
    size_t size;
    size_t count;
    struct _AssocArrayPair
    {
        const struct _AssocArray *array;
        ssize_t offset;
    } pair;
} AssocArray;
 
typedef struct _AssocArrayPair AssocArrayPair;
 
typedef struct _AssocArrayPair AssocArrayIter;
 
typedef enum
{
    ASSOCARRAY_INSERT_RESULT_NEW,
    ASSOCARRAY_INSERT_RESULT_REPLACED,
    ASSOCARRAY_INSERT_RESULT_FAILED
} AssocArrayInsertResult;
 
AssocArray *assoc_array_new(CompareFunc compare_keys, FreeFunc free_key, FreeFunc free_value);
 
void assoc_array_init(AssocArray *array, CompareFunc compare_keys, FreeFunc free_key, FreeFunc free_value);
 
void assoc_array_destroy(AssocArray *array);
 
void assoc_array_free(AssocArray *array);
 
void assoc_array_clear(AssocArray *array);
 
AssocArrayInsertResult assoc_array_set(AssocArray *array, void *key, void *value, bool overwrite_key);
 
void assoc_array_remove(AssocArray *array, const void *key);
 
AssocArrayPair *assoc_array_lookup(AssocArray *array, const void *key);
 
void *assoc_array_pair_get_key(const AssocArrayPair *pair);
 
#define assoc_array_pair_key(p) p->array->keys[p->offset]
 
void *assoc_array_pair_get_value(const AssocArrayPair *pair);
 
#define assoc_array_pair_value(p) p->array->values[p->offset]
 
void assoc_array_pair_set_value(AssocArrayPair *pair, void *value);
 
bool assoc_array_key_exists(const AssocArray *array, const void *key);
 
size_t assoc_array_count(const AssocArray *array);
 
size_t assoc_array_size(const AssocArray *array);
 
void assoc_array_iter_init(const AssocArray *array, AssocArrayIter *iter);
 
bool assoc_array_iter_next(AssocArrayIter *iter);
 
void *assoc_array_iter_get_key(const AssocArrayIter *iter);
 
#define assoc_array_iter_key(iter) iter.array->keys[iter.offset]
 
void *assoc_array_iter_get_value(const AssocArrayIter *iter);
 
#define assoc_array_iter_value(iter) iter.array->values[iter.offset]
 
#endif