amxc_htable.h

Go to the documentation of this file.

/****************************************************************************
**
** SPDX-License-Identifier: BSD-2-Clause-Patent
**
** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
**
** 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.
**
** Subject to the terms and conditions of this license, each copyright holder
** and contributor hereby grants to those receiving rights under this license
** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
** (except for failure to satisfy the conditions of this license) patent license
** to make, have made, use, offer to sell, sell, import, and otherwise transfer
** this software, where such license applies only to those patent claims, already
** acquired or hereafter acquired, licensable by such copyright holder or contributor
** that are necessarily infringed by:
**
** (a) their Contribution(s) (the licensed copyrights of copyright holders and
** non-copyrightable additions of contributors, in source or binary form) alone;
** or
**
** (b) combination of their Contribution(s) with the work of authorship to which
** such Contribution(s) was added by such copyright holder or contributor, if,
** at the time the Contribution is added, such addition causes such combination
** to be necessarily infringed. The patent license shall not apply to any other
** combinations which include the Contribution.
**
** Except as expressly stated above, no rights or licenses from any copyright
** holder or contributor is granted under this license, whether expressly, by
** implication, estoppel or otherwise.
**
** DISCLAIMER
**
** 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 HOLDERS 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.
**
****************************************************************************/
 
#if !defined(__AMXC_HTABLE_H__)
#define __AMXC_HTABLE_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <amxc/amxc_common.h>
#include <amxc/amxc_array.h>
 
#define amxc_htable_it_get_data(it, type, member) \
    ((type*) (((char*) it) - offsetof(type, member)))
 
#define amxc_htable_for_each(it, htable) \
    for(amxc_htable_it_t* it = amxc_htable_get_first(htable), \
        * it ## _next = amxc_htable_it_get_next(it); \
        it; \
        it = it ## _next, \
        it ## _next = amxc_htable_it_get_next(it))
 
#define amxc_htable_iterate(it, htable) \
    for(amxc_htable_it_t* it = amxc_htable_get_first(htable); \
        it; \
        it = amxc_htable_it_get_next(it))
 
#define AMXC_HTABLE_RANGE UINT32_MAX
 
typedef struct _amxc_htable_it amxc_htable_it_t;
 
struct _amxc_htable_it {
    amxc_array_it_t* ait;           
    char* key;                      
    amxc_htable_it_t* next;         
};
 
typedef unsigned int (* amxc_htable_hash_func_t) (const char* key, const unsigned int len);
 
typedef void (* amxc_htable_it_delete_t) (const char* key, amxc_htable_it_t* it);
 
typedef struct _amxc_htable {
    amxc_array_t table;             
    size_t items;                   
    amxc_htable_hash_func_t hfunc;  
    amxc_htable_it_delete_t it_del; 
} amxc_htable_t;
 
int amxc_htable_new(amxc_htable_t** htable, const size_t reserve);
 
void amxc_htable_delete(amxc_htable_t** htable, amxc_htable_it_delete_t func);
 
int amxc_htable_init(amxc_htable_t* const htable, const size_t reserve);
 
void amxc_htable_clean(amxc_htable_t* const htable, amxc_htable_it_delete_t func);
 
void amxc_htable_set_hash_func(amxc_htable_t* const htable, amxc_htable_hash_func_t func);
 
unsigned int amxc_htable_key2index(const amxc_htable_t* const htable,
                                   const char* const key);
 
AMXC_INLINE
bool amxc_htable_is_empty(const amxc_htable_t* const htable) {
    return htable != NULL ? (htable->items == 0) : true;
}
 
AMXC_INLINE
size_t amxc_htable_size(const amxc_htable_t* const htable) {
    return htable != NULL ? htable->items : 0;
}
 
AMXC_INLINE
size_t amxc_htable_capacity(const amxc_htable_t* const htable) {
    return htable != NULL ? htable->table.items : 0;
}
 
int amxc_htable_insert(amxc_htable_t* const htable,
                       const char* const key,
                       amxc_htable_it_t* const it);
 
amxc_htable_it_t* amxc_htable_get(const amxc_htable_t* const htable,
                                  const char* const key);
 
amxc_htable_it_t* amxc_htable_take(amxc_htable_t* const htable, const char* const key);
 
amxc_htable_it_t* amxc_htable_get_first(const amxc_htable_t* const htable);
 
amxc_htable_it_t* amxc_htable_get_last(const amxc_htable_t* const htable);
 
amxc_array_t* amxc_htable_get_sorted_keys(const amxc_htable_t* const htable);
 
AMXC_INLINE
bool amxc_htable_contains(const amxc_htable_t* const htable, const char* const key) {
    return amxc_htable_get(htable, key) ? true : false;
}
 
int amxc_htable_move(amxc_htable_t* const dest, amxc_htable_t* const src);
 
int amxc_htable_it_init(amxc_htable_it_t* const it);
 
void amxc_htable_it_clean(amxc_htable_it_t* const it, amxc_htable_it_delete_t func);
 
amxc_htable_it_t* amxc_htable_it_get_next(const amxc_htable_it_t* const reference);
 
amxc_htable_it_t* amxc_htable_it_get_previous(const amxc_htable_it_t* const reference);
 
amxc_htable_it_t* amxc_htable_it_get_next_key(const amxc_htable_it_t* const reference);
 
amxc_htable_it_t* amxc_htable_it_get_previous_key(const amxc_htable_it_t* const reference);
 
void amxc_htable_it_take(amxc_htable_it_t* const it);
 
AMXC_INLINE
const char* amxc_htable_it_get_key(const amxc_htable_it_t* const it) {
    return it != NULL ? it->key : NULL;
}
 
AMXC_INLINE
amxc_htable_it_t* amxc_htable_take_first(const amxc_htable_t* const htable) {
    amxc_htable_it_t* it = amxc_htable_get_first(htable);
    amxc_htable_it_take(it);
    return it;
}
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXC_HTABLE_H__