amxc_llist.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_LLIST_H__)
#define __AMXC_LLIST_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
 
#include <amxc/amxc_common.h>
 
#define AMXC_LLIST_RANGE UINT32_MAX
 
typedef struct _amxc_llist_it {
    struct _amxc_llist_it* next; 
    struct _amxc_llist_it* prev; 
    struct _amxc_llist* llist;   
} amxc_llist_it_t;
 
typedef struct _amxc_llist {
    amxc_llist_it_t* head; 
    amxc_llist_it_t* tail; 
} amxc_llist_t;
 
#define amxc_llist_it_get_data(it, type, member) \
    amxc_container_of(it, type, member)
 
#define amxc_llist_for_each(it, list) \
    for(amxc_llist_it_t* it = amxc_llist_get_first(list), \
        * it ## _next = amxc_llist_it_get_next(it); \
        it; \
        it = it ## _next, \
        it ## _next = amxc_llist_it_get_next(it))
 
#define amxc_llist_iterate(it, list) \
    for(amxc_llist_it_t* it = amxc_llist_get_first(list); \
        it; \
        it = amxc_llist_it_get_next(it))
 
#define amxc_llist_for_each_reverse(it, list) \
    for(amxc_llist_it_t* it = amxc_llist_get_last(list), \
        * it ## _prev = amxc_llist_it_get_previous(it); \
        it; \
        it = it ## _prev, \
        it ## _prev = amxc_llist_it_get_previous(it))
 
#define amxc_llist_iterate_reverse(it, list) \
    for(amxc_llist_it_t* it = amxc_llist_get_last(list); \
        it; \
        it = amxc_llist_it_get_previous(it))
 
typedef void (* amxc_llist_it_delete_t) (amxc_llist_it_t* it);
 
typedef int (* amxc_llist_it_cmp_t) (amxc_llist_it_t* it1,
                                     amxc_llist_it_t* it2);
 
int amxc_llist_new(amxc_llist_t** llist);
 
void amxc_llist_delete(amxc_llist_t** llist, amxc_llist_it_delete_t func);
 
int amxc_llist_init(amxc_llist_t* const llist);
 
void amxc_llist_clean(amxc_llist_t* const llist, amxc_llist_it_delete_t func);
 
int amxc_llist_move(amxc_llist_t* const dest, amxc_llist_t* const src);
 
bool amxc_llist_is_empty(const amxc_llist_t* const llist);
 
size_t amxc_llist_size(const amxc_llist_t* const llist);
 
int amxc_llist_append(amxc_llist_t* const llist, amxc_llist_it_t* const it);
 
int amxc_llist_prepend(amxc_llist_t* const llist,
                       amxc_llist_it_t* const it);
 
amxc_llist_it_t* amxc_llist_get_at(const amxc_llist_t* const llist,
                                   const unsigned int index);
 
int amxc_llist_set_at(amxc_llist_t* llist,
                      const unsigned int index,
                      amxc_llist_it_t* const it);
 
int amxc_llist_it_init(amxc_llist_it_t* const it);
 
void amxc_llist_it_clean(amxc_llist_it_t* const it, amxc_llist_it_delete_t func);
 
void amxc_llist_it_take(amxc_llist_it_t* const it);
 
int amxc_llist_it_insert_before(amxc_llist_it_t* const reference,
                                amxc_llist_it_t* const it);
 
int amxc_llist_it_insert_after(amxc_llist_it_t* const reference,
                               amxc_llist_it_t* const it);
 
unsigned int amxc_llist_it_index_of(const amxc_llist_it_t* const it);
 
int amxc_llist_it_swap(amxc_llist_it_t* it1,
                       amxc_llist_it_t* it2);
 
int amxc_llist_sort(amxc_llist_t* const llist, amxc_llist_it_cmp_t cmp);
 
AMXC_INLINE
amxc_llist_it_t* amxc_llist_get_first(const amxc_llist_t* const llist) {
    return llist != NULL ? llist->head : NULL;
}
 
AMXC_INLINE
amxc_llist_it_t* amxc_llist_get_last(const amxc_llist_t* const llist) {
    return llist != NULL ? llist->tail : NULL;
}
 
AMXC_INLINE
amxc_llist_it_t* amxc_llist_take_first(amxc_llist_t* const llist) {
    amxc_llist_it_t* it = amxc_llist_get_first(llist);
    amxc_llist_it_take(it);
    return it;
}
 
AMXC_INLINE
amxc_llist_it_t* amxc_llist_take_last(amxc_llist_t* const llist) {
    amxc_llist_it_t* it = amxc_llist_get_last(llist);
    amxc_llist_it_take(it);
    return it;
}
 
AMXC_INLINE
amxc_llist_it_t* amxc_llist_take_at(const amxc_llist_t* llist,
                                    const unsigned int index) {
    amxc_llist_it_t* it = amxc_llist_get_at(llist, index);
    amxc_llist_it_take(it);
    return it;
}
 
AMXC_INLINE
amxc_llist_it_t* amxc_llist_it_get_next(const amxc_llist_it_t* const reference) {
    return reference != NULL ? reference->next : NULL;
}
 
AMXC_INLINE
amxc_llist_it_t* amxc_llist_it_get_previous(const amxc_llist_it_t* const reference) {
    return reference != NULL ? reference->prev : NULL;
}
 
AMXC_INLINE
bool amxc_llist_it_is_in_list(const amxc_llist_it_t* const it) {
    return (it != NULL && it->llist != NULL) ? true : false;
}
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXC_LLIST_H__