xref: /freebsd/contrib/mandoc/dba.h (revision 01d4e2149e5566e5d9394913dc9fb032da259e0b)
1*61d06d6bSBaptiste Daroussin /*	$Id: dba.h,v 1.2 2016/08/17 20:46:56 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 of the allocation-based version
18*61d06d6bSBaptiste Daroussin  * of the mandoc database, for read-write access.
19*61d06d6bSBaptiste Daroussin  * To be used by dba.c, dba_read.c, and makewhatis(8).
20*61d06d6bSBaptiste Daroussin  */
21*61d06d6bSBaptiste Daroussin 
22*61d06d6bSBaptiste Daroussin #define	DBP_NAME	0
23*61d06d6bSBaptiste Daroussin #define	DBP_SECT	1
24*61d06d6bSBaptiste Daroussin #define	DBP_ARCH	2
25*61d06d6bSBaptiste Daroussin #define	DBP_DESC	3
26*61d06d6bSBaptiste Daroussin #define	DBP_FILE	4
27*61d06d6bSBaptiste Daroussin #define	DBP_MAX		5
28*61d06d6bSBaptiste Daroussin 
29*61d06d6bSBaptiste Daroussin struct dba_array;
30*61d06d6bSBaptiste Daroussin 
31*61d06d6bSBaptiste Daroussin struct dba {
32*61d06d6bSBaptiste Daroussin 	struct dba_array	*pages;
33*61d06d6bSBaptiste Daroussin 	struct dba_array	*macros;
34*61d06d6bSBaptiste Daroussin };
35*61d06d6bSBaptiste Daroussin 
36*61d06d6bSBaptiste Daroussin 
37*61d06d6bSBaptiste Daroussin struct dba	*dba_new(int32_t);
38*61d06d6bSBaptiste Daroussin void		 dba_free(struct dba *);
39*61d06d6bSBaptiste Daroussin struct dba	*dba_read(const char *);
40*61d06d6bSBaptiste Daroussin int		 dba_write(const char *, struct dba *);
41*61d06d6bSBaptiste Daroussin 
42*61d06d6bSBaptiste Daroussin struct dba_array *dba_page_new(struct dba_array *, const char *,
43*61d06d6bSBaptiste Daroussin 			const char *, const char *, enum form);
44*61d06d6bSBaptiste Daroussin void		 dba_page_add(struct dba_array *, int32_t, const char *);
45*61d06d6bSBaptiste Daroussin void		 dba_page_alias(struct dba_array *, const char *, uint64_t);
46*61d06d6bSBaptiste Daroussin 
47*61d06d6bSBaptiste Daroussin void		 dba_macro_new(struct dba *, int32_t,
48*61d06d6bSBaptiste Daroussin 			const char *, const int32_t *);
49*61d06d6bSBaptiste Daroussin void		 dba_macro_add(struct dba_array *, int32_t,
50*61d06d6bSBaptiste Daroussin 			const char *, struct dba_array *);
51