darray.h

   1 // A linked-list implementation using C arrays
   2 // darray = "dynamic array"
   3
   4 #define __DARRAY_H__
   5
   6 // Thanks to this typedef, we can search-and-replace to produce dynamic arrays
   7 // for other types: labour-intensive templates. I ought to write a script to
   8 // do this.
   9 typedef void *typ_t;
  10
  11 struct darray_s {
  12   typ_t *item;
  13   int count;
  14   int max;
  15 };
  16
  17 typedef struct darray_s darray_t[1];
  18 typedef struct darray_s *darray_ptr;
  19
  20 /*@manual darray
  21 Initialize a dynamic array ''a''. Must be called before ''a'' is used.
  22 */
  23 void darray_init(darray_t a);
  24 darray_ptr darray_new();
  25
  26 /*@manual darray
  27 Clears a dynamic array ''a''. Should be called after ''a'' is no longer needed.
  28 */
  29 void darray_clear(darray_t a);
  30
  31 /*@manual darray
  32 Appends ''p'' to the dynamic array ''a''.
  33 */
  34 void darray_append(darray_t a, typ_t p);
  35
  36 /*@manual darray
  37 Returns the pointer at index ''i'' in the dynamic array ''a''.
  38 */
  39 static inline typ_t darray_at(darray_t a, int i)
  40 {
  41   return a->item[i];
  42 }
  43
  44 typ_t darray_at_test(darray_ptr a, int (*test)(typ_t));
  45
  46 int darray_index_of(darray_ptr a, typ_t p);
  47 int darray_index_of_test(darray_ptr a, int (*test)(typ_t));
  48 void darray_remove(darray_ptr a, typ_t p);
  49 typ_t darray_remove_last(darray_ptr a);
  50 void darray_remove_test(darray_ptr a, int (*test)(typ_t));
  51 void darray_swap(darray_ptr a, int i, int j);
  52
  53 /*@manual darray
  54 Removes the pointer at index ''i'' in the dynamic array ''a''.
  55 */
  56 void darray_remove_index(darray_ptr a, int n);
  57 void darray_copy(darray_ptr dst, darray_ptr src);
  58 void darray_remove_all(darray_ptr d);
  59 void darray_forall(darray_t a, void (*func)(typ_t));
  60
  61 /*@manual darray
  62 Returns the number of pointers held in ''a''.
  63 */
  64 static inline int darray_count(const darray_ptr a) { return a->count; }
  65
  66 static inline typ_t *darray_raw(const darray_ptr a) { return a->item; }
  67
  68 static inline int darray_set_count(darray_ptr a, int n) { return a->count = n; }
  69
  70 static inline int darray_is_empty(const darray_ptr a) { return !a->count; }
  71
  72 static inline typ_t darray_first(darray_t a) { return a->item[0]; }
  73
  74 static inline typ_t darray_last(darray_t a) { return a->item[a->count - 1]; }
  75
  76 void darray_qsort(darray_t a, int (*compar)(const void *, const void *));