xref: /illumos-gate/usr/src/cmd/mandoc/dbm.h (revision a40ea1a7)
1*a40ea1a7SYuri Pankov /*	$Id: dbm.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 the map-based version
18*a40ea1a7SYuri Pankov  * of the mandoc database, for read-only access.
19*a40ea1a7SYuri Pankov  * To be used by dbm*.c, dba_read.c, and man(1) and apropos(1).
20*a40ea1a7SYuri Pankov  */
21*a40ea1a7SYuri Pankov 
22*a40ea1a7SYuri Pankov enum dbm_mtype {
23*a40ea1a7SYuri Pankov 	DBM_EXACT = 0,
24*a40ea1a7SYuri Pankov 	DBM_SUB,
25*a40ea1a7SYuri Pankov 	DBM_REGEX
26*a40ea1a7SYuri Pankov };
27*a40ea1a7SYuri Pankov 
28*a40ea1a7SYuri Pankov struct dbm_match {
29*a40ea1a7SYuri Pankov 	regex_t		*re;
30*a40ea1a7SYuri Pankov 	const char	*str;
31*a40ea1a7SYuri Pankov 	enum dbm_mtype	 type;
32*a40ea1a7SYuri Pankov };
33*a40ea1a7SYuri Pankov 
34*a40ea1a7SYuri Pankov struct dbm_res {
35*a40ea1a7SYuri Pankov 	int32_t		 page;
36*a40ea1a7SYuri Pankov 	int32_t		 bits;
37*a40ea1a7SYuri Pankov };
38*a40ea1a7SYuri Pankov 
39*a40ea1a7SYuri Pankov struct dbm_page {
40*a40ea1a7SYuri Pankov 	const char	*name;
41*a40ea1a7SYuri Pankov 	const char	*sect;
42*a40ea1a7SYuri Pankov 	const char	*arch;
43*a40ea1a7SYuri Pankov 	const char	*desc;
44*a40ea1a7SYuri Pankov 	const char	*file;
45*a40ea1a7SYuri Pankov 	int32_t		 addr;
46*a40ea1a7SYuri Pankov };
47*a40ea1a7SYuri Pankov 
48*a40ea1a7SYuri Pankov struct dbm_macro {
49*a40ea1a7SYuri Pankov 	const char	*value;
50*a40ea1a7SYuri Pankov 	const int32_t	*pp;
51*a40ea1a7SYuri Pankov };
52*a40ea1a7SYuri Pankov 
53*a40ea1a7SYuri Pankov int		 dbm_open(const char *);
54*a40ea1a7SYuri Pankov void		 dbm_close(void);
55*a40ea1a7SYuri Pankov 
56*a40ea1a7SYuri Pankov int32_t		 dbm_page_count(void);
57*a40ea1a7SYuri Pankov struct dbm_page	*dbm_page_get(int32_t);
58*a40ea1a7SYuri Pankov void		 dbm_page_byname(const struct dbm_match *);
59*a40ea1a7SYuri Pankov void		 dbm_page_bysect(const struct dbm_match *);
60*a40ea1a7SYuri Pankov void		 dbm_page_byarch(const struct dbm_match *);
61*a40ea1a7SYuri Pankov void		 dbm_page_bydesc(const struct dbm_match *);
62*a40ea1a7SYuri Pankov void		 dbm_page_bymacro(int32_t, const struct dbm_match *);
63*a40ea1a7SYuri Pankov struct dbm_res	 dbm_page_next(void);
64*a40ea1a7SYuri Pankov 
65*a40ea1a7SYuri Pankov int32_t		 dbm_macro_count(int32_t);
66*a40ea1a7SYuri Pankov struct dbm_macro *dbm_macro_get(int32_t, int32_t);
67*a40ea1a7SYuri Pankov void		 dbm_macro_bypage(int32_t, int32_t);
68*a40ea1a7SYuri Pankov char		*dbm_macro_next(void);
69