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