dynarr.h

Go to the documentation of this file.

 
#ifndef CLIBS_DYNAMIC_ARRAY_H
#define CLIBS_DYNAMIC_ARRAY_H
 
#include "../headers/array_printf.h" /* for list_printf */
#include "../headers/attributes.h"   /* Private */
 
#include <stdbool.h>
#include <stdint.h>
 
 
struct dynamic_array; // defined in dynarr.c
typedef struct dynamic_array List;
 

#define list_init_type( TYPE ) list_init_size( sizeof( TYPE ) )
Constructor struct dynamic_array *list_init_size( size_t el_size );
Constructor struct dynamic_array *list_init_cap_size( size_t el_size, size_t init_cap );

int list_copy( const struct dynamic_array *old, struct dynamic_array **new_ls_container );
Constructor struct dynamic_array *list_copy_of( const struct dynamic_array * );
 

const void *list_see( const struct dynamic_array *ls, size_t idx );
const void *list_peek( const struct dynamic_array *ls );

#define list_fetch( LIST, IDX, TYPE ) \
    ( *( ( const TYPE * ) list_see( ( LIST ), ( IDX ) ) ) )

void *list_at( struct dynamic_array *, size_t idx );
void *list_at_last( struct dynamic_array * );

#define list_access( LIST, IDX, TYPE ) ( *( ( TYPE * ) list_at( ( LIST ), ( IDX ) ) ) )

int list_set_at( struct dynamic_array *, size_t index, const void *data );

int list_extend( struct dynamic_array *ls, const void *array, size_t array_len );
int list_extend_list( struct dynamic_array *ls, const struct dynamic_array *app );
int list_append( struct dynamic_array *, const void *datap );
int list_insert( struct dynamic_array *, size_t index, const void *data );

int list_pop( struct dynamic_array *, void *container );
int list_remove_fast( struct dynamic_array *, size_t index, void *container );
int list_remove( struct dynamic_array *, size_t index, void *container );

const void *list_bsearch_p( const struct dynamic_array *,
                            const void *needle,
                            int ( *cmp )( const void *, const void * ) );
int64_t list_bsearch_i( const struct dynamic_array *,
                        const void *needle,
                        int ( *cmp )( const void *, const void * ) );

const void *list_lsearch_p( const struct dynamic_array *, const void *needle );
int64_t list_lsearch_i( const struct dynamic_array *, const void *needle );

void list_sort( struct dynamic_array *ls, int ( *cmp )( const void *, const void * ) );

int list_reverse( struct dynamic_array * );

Constructor struct dynamic_array *list_reversed( const struct dynamic_array * );

int list_cmp_size( const void *l1, const void *l2 );

int list_cmp_elsize( const void *l1, const void *l2 );

void list_destroy( struct dynamic_array * );

int list_clear( struct dynamic_array *ls );
 
 
/* ––––––––––––––––––––––––––––––– PRINTERS ––––––––––––––––––––––––––––––– */

#define list_printf_sde( LIST, ITEM_TYPE, FORMAT, START_STR, DELIM, END_STR ) \
    array_printf_sde( list_items( LIST ),                                     \
                      list_size( LIST ),                                      \
                      ITEM_TYPE,                                              \
                      FORMAT,                                                 \
                      START_STR,                                              \
                      DELIM,                                                  \
                      END_STR )

#define list_printf_d( LIST, ITEM_TYPE, FORMAT, DELIM ) \
    array_printf_d( list_items( LIST ), list_size( LIST ), ITEM_TYPE, FORMAT, DELIM )

#define list_printf( LIST, ITEM_TYPE, FORMAT ) \
    array_printf( list_items( LIST ), list_size( LIST ), ITEM_TYPE, FORMAT )
 

#define list_sprintf_d( STRING, LIST, TYPE, FMTSTR, DELIM ) \
    array_sprintf_d( STRING, list_items( LIST ), list_size( LIST ), TYPE, FMTSTR, DELIM )

#define list_sprintf( STRING, LIST, TYPE, FMTSTR ) \
    array_sprintf( STRING, list_items( LIST ), list_size( LIST ), TYPE, FMTSTR )
 
 
/* ––––– GETTERS ––––– */

bool list_is_empty( const struct dynamic_array * );
size_t list_size( const struct dynamic_array * );
size_t list_el_size( const struct dynamic_array * );

const void *list_items( const struct dynamic_array * );
UseResult void *list_items_copy( const struct dynamic_array * );
 
 
#endif //CLIBS_DYNAMIC_ARRAY_H