amxc_array.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_ARRAY_H__)
#define __AMXC_ARRAY_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
 
#include <amxc/amxc_common.h>
 
typedef struct _amxc_array {
    size_t items;                   
    size_t first_used;              
    size_t last_used;               
    struct _amxc_array_it* buffer;  
} amxc_array_t;
 
typedef struct _amxc_array_it {
    amxc_array_t* array;            
    void* data;                     
} amxc_array_it_t;
 
typedef void (* amxc_array_it_delete_t) (amxc_array_it_t* it);
 
typedef int (* amxc_array_it_cmp_t) (amxc_array_it_t* it1,
                                     amxc_array_it_t* it2);
 
int8_t amxc_array_new(amxc_array_t** array, const size_t items);
 
void amxc_array_delete(amxc_array_t** array, const amxc_array_it_delete_t func);
 
int amxc_array_init(amxc_array_t* const array, const size_t items);
 
void amxc_array_clean(amxc_array_t* const array, amxc_array_it_delete_t func);
 
int amxc_array_grow(amxc_array_t* const array, const size_t items);
 
int amxc_array_shrink(amxc_array_t* const array,
                      const size_t items,
                      amxc_array_it_delete_t func);
 
int amxc_array_shift_right(amxc_array_t* const array,
                           const size_t items,
                           amxc_array_it_delete_t func);
 
int amxc_array_shift_left(amxc_array_t* const array,
                          const size_t items,
                          amxc_array_it_delete_t func);
 
bool amxc_array_is_empty(const amxc_array_t* const array);
 
size_t amxc_array_size(const amxc_array_t* const array);
 
amxc_array_it_t* amxc_array_append_data(amxc_array_t* const array, void* data);
 
amxc_array_it_t* amxc_array_prepend_data(amxc_array_t* const array, void* data);
 
amxc_array_it_t* amxc_array_get_at(const amxc_array_t* const array,
                                   const unsigned int index);
 
amxc_array_it_t* amxc_array_set_data_at(amxc_array_t* const array,
                                        const unsigned int index,
                                        void* data);
 
amxc_array_it_t* amxc_array_get_first(const amxc_array_t* const array);
 
amxc_array_it_t* amxc_array_get_first_free(const amxc_array_t* const array);
 
amxc_array_it_t* amxc_array_get_last(const amxc_array_t* const array);
 
amxc_array_it_t* amxc_array_get_last_free(const amxc_array_t* const array);
 
void* amxc_array_take_first_data(amxc_array_t* const array);
 
void* amxc_array_take_last_data(amxc_array_t* const array);
 
amxc_array_it_t* amxc_array_it_get_next(const amxc_array_it_t* const reference);
 
amxc_array_it_t* amxc_array_it_get_next_free(const amxc_array_it_t* const reference);
 
amxc_array_it_t* amxc_array_it_get_previous(const amxc_array_it_t* const reference);
 
amxc_array_it_t* amxc_array_it_get_previous_free(const amxc_array_it_t* const reference);
 
unsigned int amxc_array_it_index(const amxc_array_it_t* const it);
 
AMXC_INLINE
size_t amxc_array_capacity(const amxc_array_t* const array) {
    return (array != NULL) ? array->items : 0;
}
 
AMXC_INLINE
void* amxc_array_get_data_at(const amxc_array_t* const array,
                             const unsigned int index) {
    amxc_array_it_t* it = amxc_array_get_at(array, index);
    return (it != NULL) ? it->data : NULL;
}
 
AMXC_INLINE
void* amxc_array_it_get_data(const amxc_array_it_t* const it) {
    return (it != NULL) ? it->data : NULL;
}
 
int amxc_array_it_set_data(amxc_array_it_t* const it, void* data);
 
void* amxc_array_it_take_data(amxc_array_it_t* const it);
 
int amxc_array_it_swap(amxc_array_it_t* const it1, amxc_array_it_t* const it2);
 
int amxc_array_sort(amxc_array_t* const array, amxc_array_it_cmp_t cmp);
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXC_ARRAY_H__