src/shared/libosmocore/include/osmocom/vty/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
  18  * along with GNU Zebra; see the file COPYING.  If not, write to the Free
  19  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  20  * 02111-1307, USA.
  21  */
  22
  23 #ifndef _ZEBRA_VECTOR_H
  24 #define _ZEBRA_VECTOR_H
  25
  26 /* struct for vector */
  27 struct _vector {
  28         unsigned int active;    /* number of active slots */
  29         unsigned int alloced;   /* number of allocated slot */
  30         void **index;           /* index to data */
  31 };
  32 typedef struct _vector *vector;
  33
  34 #define VECTOR_MIN_SIZE 1
  35
  36 /* (Sometimes) usefull macros.  This macro convert index expression to
  37  array expression. */
  38 /* Reference slot at given index, caller must ensure slot is active */
  39 #define vector_slot(V,I)  ((V)->index[(I)])
  40 /* Number of active slots.
  41  * Note that this differs from vector_count() as it the count returned
  42  * will include any empty slots
  43  */
  44 #define vector_active(V) ((V)->active)
  45
  46 /* Prototypes. */
  47 vector vector_init(unsigned int size);
  48 void vector_ensure(vector v, unsigned int num);
  49 int vector_empty_slot(vector v);
  50 int vector_set(vector v, void *val);
  51 int vector_set_index(vector v, unsigned int i, void *val);
  52 void vector_unset(vector v, unsigned int i);
  53 unsigned int vector_count(vector v);
  54 void vector_only_wrapper_free(vector v);
  55 void vector_only_index_free(void *index);
  56 void vector_free(vector v);
  57 vector vector_copy(vector v);
  58
  59 void *vector_lookup(vector, unsigned int);
  60 void *vector_lookup_ensure(vector, unsigned int);
  61
  62 extern void *tall_vty_vec_ctx;
  63
  64 #endif                          /* _ZEBRA_VECTOR_H */