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