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