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