Annotation of mandoc/man.h, Revision 1.57
1.57 ! kristaps 1: /* $Id: man.h,v 1.56 2011/03/22 09:48:13 kristaps Exp $ */
1.1 kristaps 2: /*
1.54 schwarze 3: * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.11 kristaps 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.11 kristaps 9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
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.
1.1 kristaps 16: */
17: #ifndef MAN_H
18: #define MAN_H
19:
1.45 kristaps 20: enum 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,
1.47 kristaps 53: MAN_ft,
1.45 kristaps 54: MAN_MAX
55: };
1.1 kristaps 56:
1.45 kristaps 57: enum man_type {
58: MAN_TEXT,
59: MAN_ELEM,
60: MAN_ROOT,
61: MAN_BLOCK,
62: MAN_HEAD,
1.50 kristaps 63: MAN_BODY,
1.52 kristaps 64: MAN_TBL,
65: MAN_EQN
1.45 kristaps 66: };
67:
68: struct man_meta {
69: char *msec; /* `TH' section (1, 3p, etc.) */
1.54 schwarze 70: char *date; /* `TH' normalised date */
1.45 kristaps 71: char *vol; /* `TH' volume */
72: char *title; /* `TH' title (e.g., FOO) */
73: char *source; /* `TH' source (e.g., GNU) */
74: };
75:
76: struct man_node {
77: struct man_node *parent; /* parent AST node */
78: struct man_node *child; /* first child AST node */
79: struct man_node *next; /* sibling AST node */
80: struct man_node *prev; /* prior sibling AST node */
81: int nchild; /* number children */
82: int line;
83: int pos;
84: enum mant tok; /* tok or MAN__MAX if none */
85: int flags;
86: #define MAN_VALID (1 << 0) /* has been validated */
87: #define MAN_EOS (1 << 2) /* at sentence boundary */
1.51 kristaps 88: #define MAN_LINE (1 << 3) /* first macro/text on line */
1.45 kristaps 89: enum man_type type; /* AST node type */
90: char *string; /* TEXT node argument */
91: struct man_node *head; /* BLOCK node HEAD ptr */
92: struct man_node *body; /* BLOCK node BODY ptr */
1.50 kristaps 93: const struct tbl_span *span; /* TBL */
1.53 kristaps 94: const struct eqn *eqn; /* EQN */
1.45 kristaps 95: };
96:
1.57 ! kristaps 97: /* Names of macros. Index is enum mant. */
1.1 kristaps 98: extern const char *const *man_macronames;
99:
100: __BEGIN_DECLS
101:
102: struct man;
103:
104: const struct man_node *man_node(const struct man *);
105: const struct man_meta *man_meta(const struct man *);
106:
107: __END_DECLS
108:
109: #endif /*!MAN_H*/
CVSweb