map.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2021 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 "common.h"
#include "collection.h"
#include "string.h"
#include "hash_key.h"
 
#ifndef UCX_LIST_H
// forward-declare CxList
typedef struct cx_list_s CxList;
#endif

typedef struct cx_map_s CxMap;

typedef struct cx_map_entry_s CxMapEntry;

typedef struct cx_map_iterator_s CxMapIterator;

typedef struct cx_map_class_s cx_map_class;

struct cx_map_s {
    CX_COLLECTION_BASE;
    cx_map_class *cl;
};

struct cx_map_entry_s {
    const CxHashKey *key;
    void *value;
};

enum cx_map_iterator_type {
    CX_MAP_ITERATOR_PAIRS,
    CX_MAP_ITERATOR_KEYS,
    CX_MAP_ITERATOR_VALUES
};

struct cx_map_iterator_s {
    CX_ITERATOR_BASE;

    CxMap *map;

    void *elem;

    CxMapEntry entry;

    size_t slot;

    size_t index;

    size_t elem_size;

    size_t elem_count;

    enum cx_map_iterator_type type;
};

struct cx_map_class_s {
    void (*deallocate)(struct cx_map_s *map);

    void (*clear)(struct cx_map_s *map);

    CxMapEntry (*put)(CxMap *map, CxHashKey key, void *value);

    void *(*get)(const CxMap *map, CxHashKey key);

    int (*remove)(CxMap *map, CxHashKey key, void *targetbuf);

    CxMapIterator (*iterator)(const CxMap *map, enum cx_map_iterator_type type);
};

CX_EXPORT extern CxMap *const cxEmptyMap;

CX_EXTERN
void cxMapFree(CxMap *map);

CX_EXTERN CX_NONNULL
void cxMapClear(CxMap *map);

CX_EXTERN CX_NONNULL
size_t cxMapSize(const CxMap *map);

CX_EXTERN CX_NODISCARD
CxMapIterator cxMapIteratorValues(const CxMap *map);

CX_EXTERN CX_NODISCARD
CxMapIterator cxMapIteratorKeys(const CxMap *map);

CX_EXTERN CX_NODISCARD
CxMapIterator cxMapIterator(const CxMap *map);

CX_EXTERN CX_NONNULL
int cx_map_put(CxMap *map, CxHashKey key, void *value);

#define cxMapPut(map, key, value) cx_map_put(map, CX_HASH_KEY(key), value)

CX_EXTERN CX_NONNULL CX_NODISCARD
void *cx_map_emplace(CxMap *map, CxHashKey key);

#define cxMapEmplace(map, key) cx_map_emplace(map, CX_HASH_KEY(key))

CX_EXTERN CX_NONNULL CX_NODISCARD
void *cx_map_get(const CxMap *map, CxHashKey key);

#define cxMapGet(map, key) cx_map_get(map, CX_HASH_KEY(key))

#define cxMapContains(map, key) (cxMapGet(map, key) != NULL)

CX_EXTERN CX_NONNULL_ARG(1)
int cx_map_remove(CxMap *map, CxHashKey key, void *targetbuf);

#define cxMapRemove(map, key) cx_map_remove(map, CX_HASH_KEY(key), NULL)

#define cxMapRemoveAndGet(map, key, targetbuf) cx_map_remove(map, CX_HASH_KEY(key), targetbuf)

CX_EXTERN CX_NONNULL_ARG(1, 2, 3)
int cxMapClone(CxMap *dst, const CxMap *src,
        cx_clone_func clone_func, const CxAllocator *clone_allocator, void *data);

CX_EXTERN CX_NONNULL_ARG(1, 2, 3, 4)
int cxMapDifference(CxMap *dst, const CxMap *minuend, const CxMap *subtrahend,
        cx_clone_func clone_func, const CxAllocator *clone_allocator, void *data);

CX_EXTERN CX_NONNULL_ARG(1, 2, 3, 4)
int cxMapListDifference(CxMap *dst, const CxMap *src, const CxList *keys,
        cx_clone_func clone_func, const CxAllocator *clone_allocator, void *data);
 

CX_EXTERN CX_NONNULL_ARG(1, 2, 3, 4)
int cxMapIntersection(CxMap *dst, const CxMap *src, const CxMap *other,
        cx_clone_func clone_func, const CxAllocator *clone_allocator, void *data);

CX_EXTERN CX_NONNULL_ARG(1, 2, 3, 4)
int cxMapListIntersection(CxMap *dst, const CxMap *src, const CxList *keys,
        cx_clone_func clone_func, const CxAllocator *clone_allocator, void *data);

CX_EXTERN CX_NONNULL_ARG(1, 2, 3)
int cxMapUnion(CxMap *dst, const CxMap *src,
        cx_clone_func clone_func, const CxAllocator *clone_allocator, void *data);

CX_EXTERN CX_NONNULL
int cxMapCloneShallow(CxMap *dst, const CxMap *src);

CX_EXTERN CX_NONNULL
int cxMapDifferenceShallow(CxMap *dst, const CxMap *minuend, const CxMap *subtrahend);

CX_EXTERN CX_NONNULL
int cxMapListDifferenceShallow(CxMap *dst, const CxMap *src, const CxList *keys);

CX_EXTERN CX_NONNULL
int cxMapIntersectionShallow(CxMap *dst, const CxMap *src, const CxMap *other);

CX_EXTERN CX_NONNULL
int cxMapListIntersectionShallow(CxMap *dst, const CxMap *src, const CxList *keys);

CX_EXTERN CX_NONNULL
int cxMapUnionShallow(CxMap *dst, const CxMap *src);

CX_EXTERN CX_NONNULL
int cxMapCompare(const CxMap *map, const CxMap *other);
 
#endif // UCX_MAP_H