1/* $Id: man.h,v 1.77 2015/11/07 14:01:16 schwarze Exp $ */
| 1/* $Id: man.h,v 1.60 2012/01/03 15:16:24 kristaps Exp $ */
|
2/*
3 * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
| 2/*
3 * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
|
4 * Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
| |
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 *
| 4 *
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
8 *
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
| 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
| 10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
| 11 * 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 */
| 12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 */
|
| 17#ifndef MAN_H
18#define MAN_H
|
18
| 19
|
19#define MAN_br 0
20#define MAN_TH 1
21#define MAN_SH 2
22#define MAN_SS 3
23#define MAN_TP 4
24#define MAN_LP 5
25#define MAN_PP 6
26#define MAN_P 7
27#define MAN_IP 8
28#define MAN_HP 9
29#define MAN_SM 10
30#define MAN_SB 11
31#define MAN_BI 12
32#define MAN_IB 13
33#define MAN_BR 14
34#define MAN_RB 15
35#define MAN_R 16
36#define MAN_B 17
37#define MAN_I 18
38#define MAN_IR 19
39#define MAN_RI 20
40#define MAN_sp 21
41#define MAN_nf 22
42#define MAN_fi 23
43#define MAN_RE 24
44#define MAN_RS 25
45#define MAN_DT 26
46#define MAN_UC 27
47#define MAN_PD 28
48#define MAN_AT 29
49#define MAN_in 30
50#define MAN_ft 31
51#define MAN_OP 32
52#define MAN_EX 33
53#define MAN_EE 34
54#define MAN_UR 35
55#define MAN_UE 36
56#define MAN_ll 37
57#define MAN_MAX 38
| 20enum mant {
21 MAN_br = 0,
22 MAN_TH,
23 MAN_SH,
24 MAN_SS,
25 MAN_TP,
26 MAN_LP,
27 MAN_PP,
28 MAN_P,
29 MAN_IP,
30 MAN_HP,
31 MAN_SM,
32 MAN_SB,
33 MAN_BI,
34 MAN_IB,
35 MAN_BR,
36 MAN_RB,
37 MAN_R,
38 MAN_B,
39 MAN_I,
40 MAN_IR,
41 MAN_RI,
42 MAN_na,
43 MAN_sp,
44 MAN_nf,
45 MAN_fi,
46 MAN_RE,
47 MAN_RS,
48 MAN_DT,
49 MAN_UC,
50 MAN_PD,
51 MAN_AT,
52 MAN_in,
53 MAN_ft,
54 MAN_OP,
55 MAN_MAX
56};
|
58
| 57
|
59/* Names of macros. */
| 58enum man_type {
59 MAN_TEXT,
60 MAN_ELEM,
61 MAN_ROOT,
62 MAN_BLOCK,
63 MAN_HEAD,
64 MAN_BODY,
65 MAN_TAIL,
66 MAN_TBL,
67 MAN_EQN
68};
69
70struct man_meta {
71 char *msec; /* `TH' section (1, 3p, etc.) */
72 char *date; /* `TH' normalised date */
73 char *vol; /* `TH' volume */
74 char *title; /* `TH' title (e.g., FOO) */
75 char *source; /* `TH' source (e.g., GNU) */
76};
77
78struct man_node {
79 struct man_node *parent; /* parent AST node */
80 struct man_node *child; /* first child AST node */
81 struct man_node *next; /* sibling AST node */
82 struct man_node *prev; /* prior sibling AST node */
83 int nchild; /* number children */
84 int line;
85 int pos;
86 enum mant tok; /* tok or MAN__MAX if none */
87 int flags;
88#define MAN_VALID (1 << 0) /* has been validated */
89#define MAN_EOS (1 << 2) /* at sentence boundary */
90#define MAN_LINE (1 << 3) /* first macro/text on line */
91 enum man_type type; /* AST node type */
92 char *string; /* TEXT node argument */
93 struct man_node *head; /* BLOCK node HEAD ptr */
94 struct man_node *tail; /* BLOCK node TAIL ptr */
95 struct man_node *body; /* BLOCK node BODY ptr */
96 const struct tbl_span *span; /* TBL */
97 const struct eqn *eqn; /* EQN */
98};
99
100/* Names of macros. Index is enum mant. */
|
60extern const char *const *man_macronames;
61
| 101extern const char *const *man_macronames;
102
|
| 103__BEGIN_DECLS
|
62
| 104
|
63struct roff_man;
| 105struct man;
|
64
| 106
|
65const struct mparse *man_mparse(const struct roff_man *);
66void man_validate(struct roff_man *);
| 107const struct man_node *man_node(const struct man *);
108const struct man_meta *man_meta(const struct man *);
109const struct mparse *man_mparse(const struct man *);
110
111__END_DECLS
112
113#endif /*!MAN_H*/
|
| |