map.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. 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.
 *
 * 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 HOLDER 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 UCX_MAP_H
#define UCX_MAP_H

#include "ucx.h"
#include "string.h"
#include "allocator.h"
#include <stdio.h>

#ifdef  __cplusplus
extern "C" {
#endif

#define UCX_MAP_FOREACH(key,value,iter) \
        for(UcxKey key;ucx_map_iter_next(&iter,&key, (void**)&value);)

typedef struct UcxMap          UcxMap;

typedef struct UcxKey          UcxKey;

typedef struct UcxMapElement   UcxMapElement;

typedef struct UcxMapIterator  UcxMapIterator;

struct UcxMap {
    UcxAllocator  *allocator;
    UcxMapElement **map;
    size_t        size;
    size_t        count;
};

struct UcxKey {
    const void *data;
    size_t     len;
    int        hash;
};

struct UcxMapKey {
    void    *data;
    size_t  len;
    int     hash;
};

struct UcxMapElement {
    void              *data;
    
    UcxMapElement     *next;
    
    struct UcxMapKey  key;
};

struct UcxMapIterator {
    UcxMap const  *map;
    
    UcxMapElement *cur;
    
    size_t        index;
};

UcxMap *ucx_map_new(size_t size);

UcxMap *ucx_map_new_a(UcxAllocator *allocator, size_t size);

void ucx_map_free(UcxMap *map);

void ucx_map_free_content(UcxMap *map, ucx_destructor destr);

void ucx_map_clear(UcxMap *map);


int ucx_map_copy(UcxMap const *from, UcxMap *to, copy_func fnc, void *data);

UcxMap *ucx_map_clone(UcxMap const *map, copy_func fnc, void *data);

UcxMap *ucx_map_clone_a(UcxAllocator *allocator,
                        UcxMap const *map, copy_func fnc, void *data);

int ucx_map_rehash(UcxMap *map);

int ucx_map_put(UcxMap *map, UcxKey key, void *value);

void* ucx_map_get(UcxMap const *map, UcxKey key);

void* ucx_map_remove(UcxMap *map, UcxKey key);

#define ucx_map_sstr_put(map, key, value) \
    ucx_map_put(map, ucx_key(key.ptr, key.length), (void*)value)

#define ucx_map_cstr_put(map, key, value) \
    ucx_map_put(map, ucx_key(key, strlen(key)), (void*)value)

#define ucx_map_int_put(map, key, value) \
    ucx_map_put(map, ucx_key(&key, sizeof(key)), (void*)value)

#define ucx_map_sstr_get(map, key) \
    ucx_map_get(map, ucx_key(key.ptr, key.length))

#define ucx_map_cstr_get(map, key) \
    ucx_map_get(map, ucx_key(key, strlen(key)))

#define ucx_map_int_get(map, key) \
    ucx_map_get(map, ucx_key(&key, sizeof(int)))

#define ucx_map_sstr_remove(map, key) \
    ucx_map_remove(map, ucx_key(key.ptr, key.length))

#define ucx_map_cstr_remove(map, key) \
    ucx_map_remove(map, ucx_key(key, strlen(key)))

#define ucx_map_int_remove(map, key) \
    ucx_map_remove(map, ucx_key(&key, sizeof(key)))

UcxKey ucx_key(const void *data, size_t len);

int ucx_hash(const char *data, size_t len);

UcxMapIterator ucx_map_iterator(UcxMap const *map);

int ucx_map_iter_next(UcxMapIterator *iterator, UcxKey *key, void **value);

UcxMap* ucx_map_union(const UcxMap *first, const UcxMap *second,
                      copy_func cpfnc, void* cpdata);

UcxMap* ucx_map_union_a(UcxAllocator *allocator,
                        const UcxMap *first, const UcxMap *second,
                        copy_func cpfnc, void* cpdata);

UcxMap* ucx_map_intersection(const UcxMap *first, const UcxMap *second,
                             copy_func cpfnc, void* cpdata);

UcxMap* ucx_map_intersection_a(UcxAllocator *allocator,
                               const UcxMap *first, const UcxMap *second,
                               copy_func cpfnc, void* cpdata);

UcxMap* ucx_map_difference(const UcxMap *first, const UcxMap *second,
                           copy_func cpfnc, void* cpdata);

UcxMap* ucx_map_difference_a(UcxAllocator *allocator,
                             const UcxMap *first, const UcxMap *second,
                             copy_func cpfnc, void* cpdata);


#ifdef  __cplusplus
}
#endif

#endif  /* UCX_MAP_H */