[mirror_frr.git] / lib / vector.h

/*
 * Generic vector interface header.
 * Copyright (C) 1997, 98 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra 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 General Public License
 * along with GNU Zebra; see the file COPYING.  If not, write to the Free
 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#ifndef _ZEBRA_VECTOR_H
#define _ZEBRA_VECTOR_H

#include "memory.h"

/* struct for vector */
struct _vector {
	unsigned int active;  /* number of active slots */
	unsigned int alloced; /* number of allocated slot */
	void **index;	 /* index to data */
};
typedef struct _vector *vector;

#define VECTOR_MIN_SIZE 1

/* (Sometimes) usefull macros.  This macro convert index expression to
 array expression. */
/* Reference slot at given index, caller must ensure slot is active */
#define vector_slot(V,I)  ((V)->index[(I)])
/* Number of active slots.
 * Note that this differs from vector_count() as it the count returned
 * will include any empty slots
 */
#define vector_active(V) ((V)->active)

/* Prototypes. */
extern vector vector_init(unsigned int size);
extern void vector_ensure(vector v, unsigned int num);
extern int vector_empty_slot(vector v);
extern int vector_set(vector v, void *val);
extern int vector_set_index(vector v, unsigned int i, void *val);
extern void vector_unset(vector v, unsigned int i);
extern void vector_unset_value(vector v, void *val);

extern unsigned int vector_count(vector v);
extern void vector_free(vector v);
extern vector vector_copy(vector v);

extern void *vector_lookup(vector, unsigned int);
extern void *vector_lookup_ensure(vector, unsigned int);

#endif /* _ZEBRA_VECTOR_H */
Commit	Line	Data
718e3744	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
ac4d0be5	20	* 02111-1307, USA.
718e3744	21	*/
	22
	23	#ifndef _ZEBRA_VECTOR_H
	24	#define _ZEBRA_VECTOR_H
	25
4a1ab8e4	26	#include "memory.h"
4a1ab8e4	27
718e3744	28	/* struct for vector */
ac4d0be5	29	struct _vector {
	30	unsigned int active; /* number of active slots */
	31	unsigned int alloced; /* number of allocated slot */
	32	void *index; / index to data */
718e3744	33	};
	34	typedef struct _vector *vector;
	35
	36	#define VECTOR_MIN_SIZE 1
	37
	38	/* (Sometimes) usefull macros. This macro convert index expression to
	39	array expression. */
55468c86	40	/* Reference slot at given index, caller must ensure slot is active */
718e3744	41	#define vector_slot(V,I) ((V)->index[(I)])
ac4d0be5	42	/* Number of active slots.
55468c86	43	* Note that this differs from vector_count() as it the count returned
	44	* will include any empty slots
	45	*/
	46	#define vector_active(V) ((V)->active)
718e3744	47
718e3744	48	/* Prototypes. */
ac4d0be5	49	extern vector vector_init(unsigned int size);
	50	extern void vector_ensure(vector v, unsigned int num);
	51	extern int vector_empty_slot(vector v);
	52	extern int vector_set(vector v, void *val);
	53	extern int vector_set_index(vector v, unsigned int i, void *val);
	54	extern void vector_unset(vector v, unsigned int i);
	55	extern void vector_unset_value(vector v, void *val);
0d9e2046	56
ac4d0be5	57	extern unsigned int vector_count(vector v);
	58	extern void vector_free(vector v);
	59	extern vector vector_copy(vector v);
718e3744	60
ac4d0be5	61	extern void *vector_lookup(vector, unsigned int);
ac4d0be5	62	extern void *vector_lookup_ensure(vector, unsigned int);
718e3744	63
718e3744	64	#endif /* _ZEBRA_VECTOR_H */