1 /* $Id: man.h,v 1.67 2014/12/01 04:05:32 schwarze Exp $ */
3 * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
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.
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.
74 char *msec; /* `TH' section (1, 3p, etc.) */
75 char *date; /* `TH' normalised date */
76 char *vol; /* `TH' volume */
77 char *title; /* `TH' title (e.g., FOO) */
78 char *source; /* `TH' source (e.g., GNU) */
79 int hasbody; /* document is not empty */
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 */
90 enum mant tok; /* tok or MAN__MAX if none */
92 #define MAN_VALID (1 << 0) /* has been validated */
93 #define MAN_EOS (1 << 2) /* at sentence boundary */
94 #define MAN_LINE (1 << 3) /* first macro/text on line */
95 enum man_type type; /* AST node type */
96 char *string; /* TEXT node argument */
97 struct man_node *head; /* BLOCK node HEAD ptr */
98 struct man_node *tail; /* BLOCK node TAIL ptr */
99 struct man_node *body; /* BLOCK node BODY ptr */
100 const struct tbl_span *span; /* TBL */
101 const struct eqn *eqn; /* EQN */
104 /* Names of macros. Index is enum mant. */
105 extern const char *const *man_macronames;
111 const struct man_node *man_node(const struct man *);
112 const struct man_meta *man_meta(const struct man *);
113 const struct mparse *man_mparse(const struct man *);
114 void man_deroff(char **, const struct man_node *);