kv_list.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2025 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_KV_LIST_H
#define UCX_KV_LIST_H
 
#include "common.h"
#include "list.h"
#include "map.h"

CX_EXTERN CX_NODISCARD CX_MALLOC CX_DEALLOC(cxListFree, 1)
CxList *cxKvListCreate(const CxAllocator *allocator,
        size_t elem_size);

CX_EXTERN CX_NODISCARD CX_MALLOC CX_DEALLOC(cxMapFree, 1)
CxMap *cxKvListCreateAsMap(const CxAllocator *allocator,
        size_t elem_size);

CX_EXTERN CX_NODISCARD CX_NONNULL CX_RETURNS_NONNULL
CxList *cxKvListAsList(CxMap *map);

CX_EXTERN CX_NODISCARD CX_NONNULL CX_RETURNS_NONNULL
CxMap *cxKvListAsMap(CxList *list);

CX_EXTERN CX_NONNULL
int cx_kv_list_set_key(CxList *list, size_t index, CxHashKey key);

CX_EXTERN CX_NONNULL
int cx_kv_list_insert(CxList *list, size_t index, CxHashKey key, void *value);

#define cxKvListSetKey(list, index, key) cx_kv_list_set_key(list, index, CX_HASH_KEY(key))

#define cxKvListInsert(list, index, key, value) cx_kv_list_insert(list, index, CX_HASH_KEY(key), value)

CX_EXTERN CX_NONNULL
int cxKvListRemoveKey(CxList *list, size_t index);

CX_EXTERN CX_NONNULL CX_NODISCARD
const CxHashKey *cxKvListGetKey(CxList *list, size_t index);

#define cxKvListAdd(list, key, value) cxKvListInsert(list, (list)->collection.size, key, value)
 
#endif // UCX_KV_LIST_H