Annotation of src/usr.bin/mandoc/man.h, Revision 1.47
1.47 ! schwarze 1: /* $OpenBSD$ */
1.1 kristaps 2: /*
1.33 schwarze 3: * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.42 schwarze 4: * Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.2 schwarze 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.
1.1 kristaps 17: */
18:
1.14 schwarze 19: enum mant {
20: MAN_br = 0,
21: MAN_TH,
22: MAN_SH,
23: MAN_SS,
24: MAN_TP,
25: MAN_LP,
26: MAN_PP,
27: MAN_P,
28: MAN_IP,
29: MAN_HP,
30: MAN_SM,
31: MAN_SB,
32: MAN_BI,
33: MAN_IB,
34: MAN_BR,
35: MAN_RB,
36: MAN_R,
37: MAN_B,
38: MAN_I,
39: MAN_IR,
40: MAN_RI,
41: MAN_na,
42: MAN_sp,
43: MAN_nf,
44: MAN_fi,
45: MAN_RE,
46: MAN_RS,
47: MAN_DT,
48: MAN_UC,
49: MAN_PD,
1.21 schwarze 50: MAN_AT,
1.25 schwarze 51: MAN_in,
1.29 schwarze 52: MAN_ft,
1.39 schwarze 53: MAN_OP,
1.40 schwarze 54: MAN_EX,
55: MAN_EE,
1.41 schwarze 56: MAN_UR,
57: MAN_UE,
1.43 schwarze 58: MAN_ll,
1.21 schwarze 59: MAN_MAX
1.14 schwarze 60: };
1.1 kristaps 61:
62: enum man_type {
63: MAN_TEXT,
64: MAN_ELEM,
1.7 schwarze 65: MAN_ROOT,
66: MAN_BLOCK,
67: MAN_HEAD,
1.33 schwarze 68: MAN_BODY,
1.36 schwarze 69: MAN_TBL,
70: MAN_EQN
1.1 kristaps 71: };
72:
73: struct man_meta {
1.28 schwarze 74: char *msec; /* `TH' section (1, 3p, etc.) */
1.35 schwarze 75: char *date; /* `TH' normalised date */
1.28 schwarze 76: char *vol; /* `TH' volume */
77: char *title; /* `TH' title (e.g., FOO) */
78: char *source; /* `TH' source (e.g., GNU) */
1.44 schwarze 79: int hasbody; /* document is not empty */
1.1 kristaps 80: };
81:
82: struct man_node {
1.28 schwarze 83: struct man_node *parent; /* parent AST node */
84: struct man_node *child; /* first child AST node */
85: struct man_node *next; /* sibling AST node */
86: struct man_node *prev; /* prior sibling AST node */
87: int nchild; /* number children */
1.1 kristaps 88: int line;
89: int pos;
1.28 schwarze 90: enum mant tok; /* tok or MAN__MAX if none */
1.1 kristaps 91: int flags;
1.28 schwarze 92: #define MAN_VALID (1 << 0) /* has been validated */
93: #define MAN_EOS (1 << 2) /* at sentence boundary */
1.34 schwarze 94: #define MAN_LINE (1 << 3) /* first macro/text on line */
1.28 schwarze 95: enum man_type type; /* AST node type */
96: char *string; /* TEXT node argument */
97: struct man_node *head; /* BLOCK node HEAD ptr */
1.37 schwarze 98: struct man_node *tail; /* BLOCK node TAIL ptr */
1.28 schwarze 99: struct man_node *body; /* BLOCK node BODY ptr */
1.33 schwarze 100: const struct tbl_span *span; /* TBL */
1.36 schwarze 101: const struct eqn *eqn; /* EQN */
1.1 kristaps 102: };
103:
1.37 schwarze 104: /* Names of macros. Index is enum mant. */
1.1 kristaps 105: extern const char *const *man_macronames;
106:
107: __BEGIN_DECLS
108:
109: struct man;
110:
111: const struct man_node *man_node(const struct man *);
112: const struct man_meta *man_meta(const struct man *);
1.38 schwarze 113: const struct mparse *man_mparse(const struct man *);
1.42 schwarze 114: void man_deroff(char **, const struct man_node *);
1.1 kristaps 115:
116: __END_DECLS