src/map.c

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2023 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.
 */

#include "cx/map.h"
#include <string.h>

#include "cx/list.h"

// <editor-fold desc="empty map implementation">

static void cx_empty_map_noop(cx_attr_unused CxMap *map) {
    // this is a noop, but MUST be implemented
}

static void *cx_empty_map_get(
        cx_attr_unused const CxMap *map,
        cx_attr_unused CxHashKey key
) {
    return NULL;
}

static bool cx_empty_map_iter_valid(cx_attr_unused const void *iter) {
    return false;
}

static CxMapIterator cx_empty_map_iterator(
        const struct cx_map_s *map,
        cx_attr_unused enum cx_map_iterator_type type
) {
    CxMapIterator iter = {0};
    iter.map = (CxMap*) map;
    iter.base.valid = cx_empty_map_iter_valid;
    return iter;
}

static struct cx_map_class_s cx_empty_map_class = {
        cx_empty_map_noop,
        cx_empty_map_noop,
        NULL,
        cx_empty_map_get,
        NULL,
        cx_empty_map_iterator
};

CxMap cx_empty_map = {
    {
        NULL,
        0,
        0,
        NULL,
        NULL,
        NULL,
        NULL,
        NULL,
        NULL,
        false,
        true
    },
    &cx_empty_map_class
};

CxMap *const cxEmptyMap = &cx_empty_map;

// </editor-fold>

void cxMapClear(CxMap *map) {
    map->cl->clear(map);
}

size_t cxMapSize(const CxMap *map) {
    return map->collection.size;
}

CxMapIterator cxMapIteratorValues(const CxMap *map) {
    if (map == NULL) map = cxEmptyMap;
    return map->cl->iterator(map, CX_MAP_ITERATOR_VALUES);
}

CxMapIterator cxMapIteratorKeys(const CxMap *map) {
    if (map == NULL) map = cxEmptyMap;
    return map->cl->iterator(map, CX_MAP_ITERATOR_KEYS);
}

CxMapIterator cxMapIterator(const CxMap *map) {
    if (map == NULL) map = cxEmptyMap;
    return map->cl->iterator(map, CX_MAP_ITERATOR_PAIRS);
}

int cx_map_put(CxMap *map, CxHashKey key, void *value) {
    return map->cl->put(map, key, value).key == NULL;
}

void *cx_map_emplace(CxMap *map, CxHashKey key) {
    const CxMapEntry entry = map->cl->put(map, key, NULL);
    if (entry.key == NULL) return NULL;
    return entry.value;
}

void *cx_map_get(const CxMap *map, CxHashKey key) {
    return map->cl->get(map, key);
}

int cx_map_remove(CxMap *map, CxHashKey key, void *targetbuf) {
    return map->cl->remove(map, key, targetbuf);
}

void cxMapFree(CxMap *map) {
    if (map == NULL) return;
    map->cl->deallocate(map);
}

static void cx_map_remove_uninitialized_entry(CxMap *map, CxHashKey key) {
    cx_destructor_func destr_bak = map->collection.simple_destructor;
    cx_destructor_func2 destr2_bak = map->collection.advanced_destructor;
    map->collection.simple_destructor = NULL;
    map->collection.advanced_destructor = NULL;
    cxMapRemove(map, key);
    map->collection.simple_destructor = destr_bak;
    map->collection.advanced_destructor = destr2_bak;
}

static void* cx_map_shallow_clone_func(void *dst, const void *src, const CxAllocator *al, void *data) {
    size_t elem_size = *(size_t*)data;
    if (dst == NULL) dst = cxMalloc(al, elem_size);
    if (dst != NULL) memcpy(dst, src, elem_size);
    return dst;
}

#define use_shallow_clone_func(map) cx_map_shallow_clone_func, NULL, (void*)&((map)->collection.elem_size)

int cxMapClone(CxMap *dst, const CxMap *src, cx_clone_func clone_func,
        const CxAllocator *clone_allocator, void *data) {
    if (clone_allocator == NULL) clone_allocator = cxDefaultAllocator;
    CxMapIterator src_iter = cxMapIterator(src);
    for (size_t i = 0; i < cxMapSize(src); i++) {
        const CxMapEntry *entry = cxIteratorCurrent(src_iter);
        void **dst_mem = cxMapEmplace(dst, *(entry->key));
        if (dst_mem == NULL) {
            return 1; // LCOV_EXCL_LINE
        }
        void *target = cxCollectionStoresPointers(dst) ? NULL : dst_mem;
        void *dst_ptr = clone_func(target, entry->value, clone_allocator, data);
        if (dst_ptr == NULL) {
            cx_map_remove_uninitialized_entry(dst, *(entry->key));
            return 1;
        }
        if (cxCollectionStoresPointers(dst)) {
            *dst_mem = dst_ptr;
        }
        cxIteratorNext(src_iter);
    }
    return 0;
}

int cxMapDifference(CxMap *dst, const CxMap *minuend, const CxMap *subtrahend,
        cx_clone_func clone_func, const CxAllocator *clone_allocator, void *data) {
    if (clone_allocator == NULL) clone_allocator = cxDefaultAllocator;

    CxMapIterator src_iter = cxMapIterator(minuend);
    cx_foreach(const CxMapEntry *, entry, src_iter) {
        if (cxMapContains(subtrahend, *entry->key)) {
            continue;
        }
        void** dst_mem = cxMapEmplace(dst, *entry->key);
        if (dst_mem == NULL) {
            return 1; // LCOV_EXCL_LINE
        }
        void *target = cxCollectionStoresPointers(dst) ? NULL : dst_mem;
        void* dst_ptr = clone_func(target, entry->value, clone_allocator, data);
        if (dst_ptr == NULL) {
            cx_map_remove_uninitialized_entry(dst, *(entry->key));
            return 1;
        }
        if (cxCollectionStoresPointers(dst)) {
            *dst_mem = dst_ptr;
        }
    }
    return 0;
}

int cxMapListDifference(CxMap *dst, const CxMap *src, const CxList *keys,
        cx_clone_func clone_func, const CxAllocator *clone_allocator, void *data) {
    if (clone_allocator == NULL) clone_allocator = cxDefaultAllocator;

    CxMapIterator src_iter = cxMapIterator(src);
    cx_foreach(const CxMapEntry *, entry, src_iter) {
        if (cxListContains(keys, entry->key)) {
            continue;
        }
        void** dst_mem = cxMapEmplace(dst, *entry->key);
        if (dst_mem == NULL) {
            return 1; // LCOV_EXCL_LINE
        }
        void *target = cxCollectionStoresPointers(dst) ? NULL : dst_mem;
        void* dst_ptr = clone_func(target, entry->value, clone_allocator, data);
        if (dst_ptr == NULL) {
            cx_map_remove_uninitialized_entry(dst, *(entry->key));
            return 1;
        }
        if (cxCollectionStoresPointers(dst)) {
            *dst_mem = dst_ptr;
        }
    }
    return 0;
}

int cxMapIntersection(CxMap *dst, const CxMap *src, const CxMap *other,
        cx_clone_func clone_func, const CxAllocator *clone_allocator, void *data) {
    if (clone_allocator == NULL) clone_allocator = cxDefaultAllocator;

    CxMapIterator src_iter = cxMapIterator(src);
    cx_foreach(const CxMapEntry *, entry, src_iter) {
        if (!cxMapContains(other, *entry->key)) {
            continue;
        }
        void** dst_mem = cxMapEmplace(dst, *entry->key);
        if (dst_mem == NULL) {
            return 1; // LCOV_EXCL_LINE
        }
        void *target = cxCollectionStoresPointers(dst) ? NULL : dst_mem;
        void* dst_ptr = clone_func(target, entry->value, clone_allocator, data);
        if (dst_ptr == NULL) {
            cx_map_remove_uninitialized_entry(dst, *(entry->key));
            return 1;
        }
        if (cxCollectionStoresPointers(dst)) {
            *dst_mem = dst_ptr;
        }
    }
    return 0;
}

int cxMapListIntersection(CxMap *dst, const CxMap *src, const CxList *keys,
        cx_clone_func clone_func, const CxAllocator *clone_allocator, void *data) {
    if (clone_allocator == NULL) clone_allocator = cxDefaultAllocator;

    CxMapIterator src_iter = cxMapIterator(src);
    cx_foreach(const CxMapEntry *, entry, src_iter) {
        if (!cxListContains(keys, entry->key)) {
            continue;
        }
        void** dst_mem = cxMapEmplace(dst, *entry->key);
        if (dst_mem == NULL) {
            return 1; // LCOV_EXCL_LINE
        }
        void *target = cxCollectionStoresPointers(dst) ? NULL : dst_mem;
        void* dst_ptr = clone_func(target, entry->value, clone_allocator, data);
        if (dst_ptr == NULL) {
            cx_map_remove_uninitialized_entry(dst, *(entry->key));
            return 1;
        }
        if (cxCollectionStoresPointers(dst)) {
            *dst_mem = dst_ptr;
        }
    }
    return 0;
}

int cxMapUnion(CxMap *dst, const CxMap *src,
        cx_clone_func clone_func, const CxAllocator *clone_allocator, void *data) {
    if (clone_allocator == NULL) clone_allocator = cxDefaultAllocator;

    CxMapIterator src_iter = cxMapIterator(src);
    cx_foreach(const CxMapEntry *, entry, src_iter) {
        if (cxMapContains(dst, *entry->key)) {
            continue;
        }
        void** dst_mem = cxMapEmplace(dst, *entry->key);
        if (dst_mem == NULL) {
            return 1; // LCOV_EXCL_LINE
        }
        void *target = cxCollectionStoresPointers(dst) ? NULL : dst_mem;
        void* dst_ptr = clone_func(target, entry->value, clone_allocator, data);
        if (dst_ptr == NULL) {
            cx_map_remove_uninitialized_entry(dst, *(entry->key));
            return 1;
        }
        if (cxCollectionStoresPointers(dst)) {
            *dst_mem = dst_ptr;
        }
    }
    return 0;
}

int cxMapCloneShallow(CxMap *dst, const CxMap *src) {
    return cxMapClone(dst, src, use_shallow_clone_func(src));
}

int cxMapDifferenceShallow(CxMap *dst, const CxMap *minuend, const CxMap *subtrahend) {
    return cxMapDifference(dst, minuend, subtrahend, use_shallow_clone_func(minuend));
}

int cxMapListDifferenceShallow(CxMap *dst, const CxMap *src, const CxList *keys) {
    return cxMapListDifference(dst, src, keys, use_shallow_clone_func(src));
}

int cxMapIntersectionShallow(CxMap *dst, const CxMap *src, const CxMap *other) {
    return cxMapIntersection(dst, src, other, use_shallow_clone_func(src));
}

int cxMapListIntersectionShallow(CxMap *dst, const CxMap *src, const CxList *keys) {
    return cxMapListIntersection(dst, src, keys, use_shallow_clone_func(src));
}

int cxMapUnionShallow(CxMap *dst, const CxMap *src) {
    return cxMapUnion(dst, src, use_shallow_clone_func(src));
}

int cxMapCompare(const CxMap *map, const CxMap *other) {
    // compare map sizes
    const size_t size_left = cxMapSize(map);
    const size_t size_right = cxMapSize(other);
    if (size_left < size_right) {
        return -1;
    } else if (size_left > size_right) {
        return 1;
    }

    // iterate through the first map
    CxMapIterator iter = cxMapIterator(map);
    cx_foreach(const CxMapEntry *, entry, iter) {
        const void *value_left = entry->value;
        const void *value_right = cxMapGet(other, *entry->key);
        // if the other map does not have the key, we are done
        if (value_right == NULL) {
            return -1;
        }
        // compare the values
        const int d = cx_invoke_compare_func(map, value_left, value_right);
        if (d != 0) {
            return d;
        }
    }

    return 0;
}