Annotation of mandoc/mansearch.h, Revision 1.19
1.19 ! schwarze 1: /* $Id: mansearch.h,v 1.18 2014/09/03 18:09:14 schwarze Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.10 schwarze 4: * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
18: #ifndef MANSEARCH_H
19: #define MANSEARCH_H
20:
1.4 schwarze 21: #define MANDOC_DB "mandoc.db"
1.2 kristaps 22:
1.12 schwarze 23: #define TYPE_arch 0x0000000000000001ULL
24: #define TYPE_sec 0x0000000000000002ULL
25: #define TYPE_Xr 0x0000000000000004ULL
26: #define TYPE_Ar 0x0000000000000008ULL
27: #define TYPE_Fa 0x0000000000000010ULL
28: #define TYPE_Fl 0x0000000000000020ULL
29: #define TYPE_Dv 0x0000000000000040ULL
30: #define TYPE_Fn 0x0000000000000080ULL
31: #define TYPE_Ic 0x0000000000000100ULL
32: #define TYPE_Pa 0x0000000000000200ULL
33: #define TYPE_Cm 0x0000000000000400ULL
34: #define TYPE_Li 0x0000000000000800ULL
35: #define TYPE_Em 0x0000000000001000ULL
36: #define TYPE_Cd 0x0000000000002000ULL
37: #define TYPE_Va 0x0000000000004000ULL
38: #define TYPE_Ft 0x0000000000008000ULL
39: #define TYPE_Tn 0x0000000000010000ULL
40: #define TYPE_Er 0x0000000000020000ULL
41: #define TYPE_Ev 0x0000000000040000ULL
42: #define TYPE_Sy 0x0000000000080000ULL
43: #define TYPE_Sh 0x0000000000100000ULL
44: #define TYPE_In 0x0000000000200000ULL
45: #define TYPE_Ss 0x0000000000400000ULL
46: #define TYPE_Ox 0x0000000000800000ULL
47: #define TYPE_An 0x0000000001000000ULL
48: #define TYPE_Mt 0x0000000002000000ULL
49: #define TYPE_St 0x0000000004000000ULL
50: #define TYPE_Bx 0x0000000008000000ULL
51: #define TYPE_At 0x0000000010000000ULL
52: #define TYPE_Nx 0x0000000020000000ULL
53: #define TYPE_Fx 0x0000000040000000ULL
54: #define TYPE_Lk 0x0000000080000000ULL
55: #define TYPE_Ms 0x0000000100000000ULL
56: #define TYPE_Bsx 0x0000000200000000ULL
57: #define TYPE_Dx 0x0000000400000000ULL
58: #define TYPE_Rs 0x0000000800000000ULL
59: #define TYPE_Vt 0x0000001000000000ULL
60: #define TYPE_Lb 0x0000002000000000ULL
61: #define TYPE_Nm 0x0000004000000000ULL
62: #define TYPE_Nd 0x0000008000000000ULL
63:
64: #define NAME_SYN 0x0000004000000001ULL
65: #define NAME_FILE 0x0000004000000002ULL
66: #define NAME_TITLE 0x000000400000000cULL
67: #define NAME_FIRST 0x0000004000000008ULL
68: #define NAME_HEAD 0x0000004000000010ULL
69: #define NAME_MASK 0x000000000000001fULL
1.18 schwarze 70:
71: #define FORM_CAT 0 /* manual page is preformatted */
72: #define FORM_SRC 1 /* format is mdoc(7) or man(7) */
73: #define FORM_GZ 2 /* compressed with gzip(1) */
74: #define FORM_NONE 4 /* format is unknown */
1.2 kristaps 75:
1.16 schwarze 76: enum argmode {
77: ARG_FILE = 0,
78: ARG_NAME,
79: ARG_WORD,
80: ARG_EXPR
81: };
1.2 kristaps 82:
1.1 kristaps 83: struct manpage {
1.5 schwarze 84: char *file; /* to be prefixed by manpath */
85: char *names; /* a list of names with sections */
1.6 schwarze 86: char *output; /* user-defined additional output */
1.17 schwarze 87: size_t ipath; /* number of the manpath */
1.15 schwarze 88: int sec; /* section number, 10 means invalid */
1.1 kristaps 89: int form; /* 0 == catpage */
90: };
91:
1.2 kristaps 92: struct mansearch {
93: const char *arch; /* architecture/NULL */
94: const char *sec; /* mansection/NULL */
1.16 schwarze 95: const char *outkey; /* show content of this macro */
96: enum argmode argmode; /* interpretation of arguments */
1.19 ! schwarze 97: int firstmatch; /* first matching database only */
1.2 kristaps 98: };
1.1 kristaps 99:
1.16 schwarze 100: __BEGIN_DECLS
101:
1.13 schwarze 102: int mansearch_setup(int);
1.2 kristaps 103: int mansearch(const struct mansearch *cfg, /* options */
104: const struct manpaths *paths, /* manpaths */
1.1 kristaps 105: int argc, /* size of argv */
106: char *argv[], /* search terms */
107: struct manpage **res, /* results */
108: size_t *ressz); /* results returned */
1.16 schwarze 109: void mansearch_free(struct manpage *, size_t);
1.1 kristaps 110:
111: __END_DECLS
112:
1.16 schwarze 113: #endif /* MANSEARCH_H */
CVSweb