Annotation of mandoc/man.h, Revision 1.63
1.63 ! schwarze 1: /* $Id: man.h,v 1.62 2013/10/17 20:54:58 schwarze Exp $ */
1.1 kristaps 2: /*
1.54 schwarze 3: * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.63 ! 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.11 kristaps 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.11 kristaps 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: #ifndef MAN_H
19: #define MAN_H
20:
1.45 kristaps 21: enum mant {
22: MAN_br = 0,
23: MAN_TH,
24: MAN_SH,
25: MAN_SS,
26: MAN_TP,
27: MAN_LP,
28: MAN_PP,
29: MAN_P,
30: MAN_IP,
31: MAN_HP,
32: MAN_SM,
33: MAN_SB,
34: MAN_BI,
35: MAN_IB,
36: MAN_BR,
37: MAN_RB,
38: MAN_R,
39: MAN_B,
40: MAN_I,
41: MAN_IR,
42: MAN_RI,
43: MAN_na,
44: MAN_sp,
45: MAN_nf,
46: MAN_fi,
47: MAN_RE,
48: MAN_RS,
49: MAN_DT,
50: MAN_UC,
51: MAN_PD,
52: MAN_AT,
53: MAN_in,
1.47 kristaps 54: MAN_ft,
1.60 kristaps 55: MAN_OP,
1.61 schwarze 56: MAN_EX,
57: MAN_EE,
1.62 schwarze 58: MAN_UR,
59: MAN_UE,
1.45 kristaps 60: MAN_MAX
61: };
1.1 kristaps 62:
1.45 kristaps 63: enum man_type {
64: MAN_TEXT,
65: MAN_ELEM,
66: MAN_ROOT,
67: MAN_BLOCK,
68: MAN_HEAD,
1.50 kristaps 69: MAN_BODY,
1.58 kristaps 70: MAN_TAIL,
1.52 kristaps 71: MAN_TBL,
72: MAN_EQN
1.45 kristaps 73: };
74:
75: struct man_meta {
76: char *msec; /* `TH' section (1, 3p, etc.) */
1.54 schwarze 77: char *date; /* `TH' normalised date */
1.45 kristaps 78: char *vol; /* `TH' volume */
79: char *title; /* `TH' title (e.g., FOO) */
80: char *source; /* `TH' source (e.g., GNU) */
81: };
82:
83: struct man_node {
84: struct man_node *parent; /* parent AST node */
85: struct man_node *child; /* first child AST node */
86: struct man_node *next; /* sibling AST node */
87: struct man_node *prev; /* prior sibling AST node */
88: int nchild; /* number children */
89: int line;
90: int pos;
91: enum mant tok; /* tok or MAN__MAX if none */
92: int flags;
93: #define MAN_VALID (1 << 0) /* has been validated */
94: #define MAN_EOS (1 << 2) /* at sentence boundary */
1.51 kristaps 95: #define MAN_LINE (1 << 3) /* first macro/text on line */
1.45 kristaps 96: enum man_type type; /* AST node type */
97: char *string; /* TEXT node argument */
98: struct man_node *head; /* BLOCK node HEAD ptr */
1.58 kristaps 99: struct man_node *tail; /* BLOCK node TAIL ptr */
1.45 kristaps 100: struct man_node *body; /* BLOCK node BODY ptr */
1.50 kristaps 101: const struct tbl_span *span; /* TBL */
1.53 kristaps 102: const struct eqn *eqn; /* EQN */
1.45 kristaps 103: };
104:
1.57 kristaps 105: /* Names of macros. Index is enum mant. */
1.1 kristaps 106: extern const char *const *man_macronames;
107:
108: __BEGIN_DECLS
109:
110: struct man;
111:
112: const struct man_node *man_node(const struct man *);
113: const struct man_meta *man_meta(const struct man *);
1.59 kristaps 114: const struct mparse *man_mparse(const struct man *);
1.63 ! schwarze 115: void man_deroff(char **, const struct man_node *);
1.1 kristaps 116:
117: __END_DECLS
118:
119: #endif /*!MAN_H*/
CVSweb