xref: /dflybsd-src/contrib/mdocml/dba.h (revision 54ba96075f5891e4574304da6ba88f1a1afe520b)
1*54ba9607SSascha Wildner /*	$Id: dba.h,v 1.2 2016/08/17 20:46:56 schwarze Exp $ */
2*54ba9607SSascha Wildner /*
3*54ba9607SSascha Wildner  * Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
4*54ba9607SSascha Wildner  *
5*54ba9607SSascha Wildner  * Permission to use, copy, modify, and distribute this software for any
6*54ba9607SSascha Wildner  * purpose with or without fee is hereby granted, provided that the above
7*54ba9607SSascha Wildner  * copyright notice and this permission notice appear in all copies.
8*54ba9607SSascha Wildner  *
9*54ba9607SSascha Wildner  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10*54ba9607SSascha Wildner  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11*54ba9607SSascha Wildner  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12*54ba9607SSascha Wildner  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13*54ba9607SSascha Wildner  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14*54ba9607SSascha Wildner  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15*54ba9607SSascha Wildner  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16*54ba9607SSascha Wildner  *
17*54ba9607SSascha Wildner  * Public interface of the allocation-based version
18*54ba9607SSascha Wildner  * of the mandoc database, for read-write access.
19*54ba9607SSascha Wildner  * To be used by dba.c, dba_read.c, and makewhatis(8).
20*54ba9607SSascha Wildner  */
21*54ba9607SSascha Wildner 
22*54ba9607SSascha Wildner #define	DBP_NAME	0
23*54ba9607SSascha Wildner #define	DBP_SECT	1
24*54ba9607SSascha Wildner #define	DBP_ARCH	2
25*54ba9607SSascha Wildner #define	DBP_DESC	3
26*54ba9607SSascha Wildner #define	DBP_FILE	4
27*54ba9607SSascha Wildner #define	DBP_MAX		5
28*54ba9607SSascha Wildner 
29*54ba9607SSascha Wildner struct dba_array;
30*54ba9607SSascha Wildner 
31*54ba9607SSascha Wildner struct dba {
32*54ba9607SSascha Wildner 	struct dba_array	*pages;
33*54ba9607SSascha Wildner 	struct dba_array	*macros;
34*54ba9607SSascha Wildner };
35*54ba9607SSascha Wildner 
36*54ba9607SSascha Wildner 
37*54ba9607SSascha Wildner struct dba	*dba_new(int32_t);
38*54ba9607SSascha Wildner void		 dba_free(struct dba *);
39*54ba9607SSascha Wildner struct dba	*dba_read(const char *);
40*54ba9607SSascha Wildner int		 dba_write(const char *, struct dba *);
41*54ba9607SSascha Wildner 
42*54ba9607SSascha Wildner struct dba_array *dba_page_new(struct dba_array *, const char *,
43*54ba9607SSascha Wildner 			const char *, const char *, enum form);
44*54ba9607SSascha Wildner void		 dba_page_add(struct dba_array *, int32_t, const char *);
45*54ba9607SSascha Wildner void		 dba_page_alias(struct dba_array *, const char *, uint64_t);
46*54ba9607SSascha Wildner 
47*54ba9607SSascha Wildner void		 dba_macro_new(struct dba *, int32_t,
48*54ba9607SSascha Wildner 			const char *, const int32_t *);
49*54ba9607SSascha Wildner void		 dba_macro_add(struct dba_array *, int32_t,
50*54ba9607SSascha Wildner 			const char *, struct dba_array *);
51