ref_array.h

/*
    REF ARRAY

    Header file for of the dynamic array with reference count.

    Copyright (C) Dmitri Pal <dpal@redhat.com> 2009

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef REF_ARRAY_H
#define REF_ARRAY_H

#include <stdint.h>
#include <stdlib.h>

struct ref_array;

#ifndef EOK
#define EOK 0
#endif

typedef enum
{
    REF_ARRAY_DESTROY,
    REF_ARRAY_DELETE,
} ref_array_del_enum;


typedef void (*ref_array_fn)(void *elem,
                             ref_array_del_enum type,
                             void *data);

typedef int (*ref_array_copy_cb)(void *elem,
                                 void *new_elem);

int ref_array_create(struct ref_array **ra,
                     size_t elem,
                     uint32_t grow_by,
                     ref_array_fn cb,
                     void *data);

struct ref_array *ref_array_getref(struct ref_array *ra);

void ref_array_destroy(struct ref_array *ra);

int ref_array_append(struct ref_array *ra, void *element);

void *ref_array_get(struct ref_array *ra, uint32_t idx, void *acptr);

int ref_array_getlen(struct ref_array *ra, uint32_t *len);

uint32_t ref_array_len(struct ref_array *ra);

int ref_array_insert(struct ref_array *ra,
                     uint32_t idx,
                     void *element);
int ref_array_replace(struct ref_array *ra,
                      uint32_t idx,
                      void *element);


int ref_array_remove(struct ref_array *ra,
                     uint32_t idx);


int ref_array_swap(struct ref_array *ra,
                   uint32_t idx1,
                   uint32_t idx2);


void ref_array_reset(struct ref_array *ra);


int ref_array_copy(struct ref_array *ra,
                   ref_array_copy_cb copy_cb,
                   ref_array_fn cb,
                   void *data,
                   struct ref_array **copy_ra);



void ref_array_debug(struct ref_array *ra, int num);

#endif