Annotation of mandoc/man.h, Revision 1.70
1.70 ! schwarze 1: /* $Id: man.h,v 1.69 2015/01/24 02:41:49 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:
1.45 kristaps 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_sp,
42: MAN_nf,
43: MAN_fi,
44: MAN_RE,
45: MAN_RS,
46: MAN_DT,
47: MAN_UC,
48: MAN_PD,
49: MAN_AT,
50: MAN_in,
1.47 kristaps 51: MAN_ft,
1.60 kristaps 52: MAN_OP,
1.61 schwarze 53: MAN_EX,
54: MAN_EE,
1.62 schwarze 55: MAN_UR,
56: MAN_UE,
1.64 schwarze 57: MAN_ll,
1.45 kristaps 58: MAN_MAX
59: };
1.1 kristaps 60:
1.45 kristaps 61: struct man_meta {
62: char *msec; /* `TH' section (1, 3p, etc.) */
1.54 schwarze 63: char *date; /* `TH' normalised date */
1.45 kristaps 64: char *vol; /* `TH' volume */
65: char *title; /* `TH' title (e.g., FOO) */
66: char *source; /* `TH' source (e.g., GNU) */
1.65 schwarze 67: int hasbody; /* document is not empty */
1.45 kristaps 68: };
69:
70: struct man_node {
71: struct man_node *parent; /* parent AST node */
72: struct man_node *child; /* first child AST node */
73: struct man_node *next; /* sibling AST node */
74: struct man_node *prev; /* prior sibling AST node */
75: int nchild; /* number children */
76: int line;
77: int pos;
78: enum mant tok; /* tok or MAN__MAX if none */
79: int flags;
80: #define MAN_VALID (1 << 0) /* has been validated */
81: #define MAN_EOS (1 << 2) /* at sentence boundary */
1.51 kristaps 82: #define MAN_LINE (1 << 3) /* first macro/text on line */
1.70 ! schwarze 83: enum roff_type type; /* AST node type */
1.45 kristaps 84: char *string; /* TEXT node argument */
85: struct man_node *head; /* BLOCK node HEAD ptr */
1.58 kristaps 86: struct man_node *tail; /* BLOCK node TAIL ptr */
1.45 kristaps 87: struct man_node *body; /* BLOCK node BODY ptr */
1.50 kristaps 88: const struct tbl_span *span; /* TBL */
1.53 kristaps 89: const struct eqn *eqn; /* EQN */
1.68 schwarze 90: int aux; /* decoded node data, type-dependent */
1.45 kristaps 91: };
92:
1.57 kristaps 93: /* Names of macros. Index is enum mant. */
1.1 kristaps 94: extern const char *const *man_macronames;
95:
96: __BEGIN_DECLS
97:
98: struct man;
99:
100: const struct man_node *man_node(const struct man *);
101: const struct man_meta *man_meta(const struct man *);
1.59 kristaps 102: const struct mparse *man_mparse(const struct man *);
1.63 schwarze 103: void man_deroff(char **, const struct man_node *);
1.1 kristaps 104:
105: __END_DECLS
CVSweb