include/ecoli_vec.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
   3  */
   4
   5 /**
   6  * Vectors of objects.
   7  *
   8  * The ec_vec API provide helpers to manipulate vectors of objects
   9  * of any kind.
  10  */
  11
  12 #ifndef ECOLI_VEC_
  13 #define ECOLI_VEC_
  14
  15 #include <sys/types.h>
  16 #include <stdint.h>
  17 #include <stdio.h>
  18
  19 /* if NULL, default does nothing */
  20 typedef void (*ec_vec_elt_free_t)(void *ptr);
  21
  22 /* if NULL, default is:
  23  * memcpy(dst, src, vec->elt_size)
  24  */
  25 typedef void (*ec_vec_elt_copy_t)(void *dst, void *src);
  26
  27 struct ec_vec *ec_vec(size_t elt_size, size_t size,
  28                 ec_vec_elt_copy_t copy, ec_vec_elt_free_t free);
  29 int ec_vec_add_by_ref(struct ec_vec *vec, void *ptr);
  30
  31 int ec_vec_add_ptr(struct ec_vec *vec, void *elt);
  32 int ec_vec_add_u8(struct ec_vec *vec, uint8_t elt);
  33 int ec_vec_add_u16(struct ec_vec *vec, uint16_t elt);
  34 int ec_vec_add_u32(struct ec_vec *vec, uint32_t elt);
  35 int ec_vec_add_u64(struct ec_vec *vec, uint64_t elt);
  36
  37 int ec_vec_get(void *ptr, const struct ec_vec *vec, size_t idx);
  38
  39 struct ec_vec *ec_vec_dup(const struct ec_vec *vec);
  40 struct ec_vec *ec_vec_ndup(const struct ec_vec *vec,
  41         size_t off, size_t len);
  42 void ec_vec_free(struct ec_vec *vec);
  43
  44 __attribute__((pure))
  45 size_t ec_vec_len(const struct ec_vec *vec);
  46
  47 #endif