xref: /netbsd-src/external/bsd/mdocml/dist/dba_array.h (revision 9508192e445c6bc8463a56d16765781892ab889e)
1*9508192eSchristos /*	Id: dba_array.h,v 1.1 2016/07/19 21:31:55 schwarze Exp  */
2*9508192eSchristos /*
3*9508192eSchristos  * Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
4*9508192eSchristos  *
5*9508192eSchristos  * Permission to use, copy, modify, and distribute this software for any
6*9508192eSchristos  * purpose with or without fee is hereby granted, provided that the above
7*9508192eSchristos  * copyright notice and this permission notice appear in all copies.
8*9508192eSchristos  *
9*9508192eSchristos  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10*9508192eSchristos  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11*9508192eSchristos  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12*9508192eSchristos  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13*9508192eSchristos  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14*9508192eSchristos  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15*9508192eSchristos  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16*9508192eSchristos  *
17*9508192eSchristos  * Public interface for allocation-based arrays
18*9508192eSchristos  * for the mandoc database, for read-write access.
19*9508192eSchristos  * To be used by dba*.c and by makewhatis(8).
20*9508192eSchristos  */
21*9508192eSchristos 
22*9508192eSchristos struct dba_array;
23*9508192eSchristos 
24*9508192eSchristos #define	DBA_STR		0x01	/* Map contains strings, not pointers. */
25*9508192eSchristos #define	DBA_GROW	0x02	/* Allow the array to grow. */
26*9508192eSchristos 
27*9508192eSchristos #define	dba_array_FOREACH(a, e) \
28*9508192eSchristos 	dba_array_start(a); \
29*9508192eSchristos 	while (((e) = dba_array_next(a)) != NULL)
30*9508192eSchristos 
31*9508192eSchristos typedef int dba_compare_func(const void *, const void *);
32*9508192eSchristos 
33*9508192eSchristos struct dba_array *dba_array_new(int32_t, int);
34*9508192eSchristos void		 dba_array_free(struct dba_array *);
35*9508192eSchristos void		 dba_array_set(struct dba_array *, int32_t, void *);
36*9508192eSchristos void		 dba_array_add(struct dba_array *, void *);
37*9508192eSchristos void		*dba_array_get(struct dba_array *, int32_t);
38*9508192eSchristos void		 dba_array_start(struct dba_array *);
39*9508192eSchristos void		*dba_array_next(struct dba_array *);
40*9508192eSchristos void		 dba_array_del(struct dba_array *);
41*9508192eSchristos void		 dba_array_undel(struct dba_array *);
42*9508192eSchristos void		 dba_array_setpos(struct dba_array *, int32_t, int32_t);
43*9508192eSchristos int32_t		 dba_array_getpos(struct dba_array *);
44*9508192eSchristos void		 dba_array_sort(struct dba_array *, dba_compare_func);
45*9508192eSchristos int32_t		 dba_array_writelen(struct dba_array *, int32_t);
46*9508192eSchristos void		 dba_array_writepos(struct dba_array *);
47*9508192eSchristos void		 dba_array_writelst(struct dba_array *);
48