lib/vector.h

   1 /*
   2  * Generic vector interface header.
   3  * Copyright (C) 1997, 98 Kunihiro Ishiguro
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   7  * GNU Zebra is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2, or (at your option) any
  10  * later version.
  11  *
  12  * GNU Zebra is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef _ZEBRA_VECTOR_H
  23 #define _ZEBRA_VECTOR_H
  24
  25 #include "memory.h"
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /* struct for vector */
  32 struct _vector {
  33         unsigned int active;  /* number of active slots */
  34         unsigned int alloced; /* number of allocated slot */
  35         void **index;    /* index to data */
  36 };
  37 typedef struct _vector *vector;
  38
  39 #define VECTOR_MIN_SIZE 1
  40
  41 /* (Sometimes) usefull macros.  This macro convert index expression to
  42  array expression. */
  43 /* Reference slot at given index, caller must ensure slot is active */
  44 #define vector_slot(V,I)  ((V)->index[(I)])
  45 /* Number of active slots.
  46  * Note that this differs from vector_count() as it the count returned
  47  * will include any empty slots
  48  */
  49 #define vector_active(V) ((V)->active)
  50
  51 /* Prototypes. */
  52 extern vector vector_init(unsigned int size);
  53 extern void vector_ensure(vector v, unsigned int num);
  54 extern int vector_empty_slot(vector v);
  55 extern int vector_set(vector v, void *val);
  56 extern int vector_set_index(vector v, unsigned int i, void *val);
  57 extern void vector_unset(vector v, unsigned int i);
  58 extern void vector_unset_value(vector v, void *val);
  59 extern void vector_remove(vector v, unsigned int ix);
  60 extern void vector_compact(vector v);
  61
  62 extern unsigned int vector_count(vector v);
  63 extern void vector_free(vector v);
  64 extern vector vector_copy(vector v);
  65
  66 extern void *vector_lookup(vector, unsigned int);
  67 extern void *vector_lookup_ensure(vector, unsigned int);
  68 extern void vector_to_array(vector v, void ***dest, int *argc);
  69 extern vector array_to_vector(void **src, int argc);
  70
  71 #ifdef __cplusplus
  72 }
  73 #endif
  74
  75 #endif /* _ZEBRA_VECTOR_H */