1 /* $Id: man.h,v 1.60 2012/01/03 15:16:24 kristaps Exp $ */ 2 /* 3 * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 4 * 5 * Permission to use, copy, modify, and distribute this software for any 6 * purpose with or without fee is hereby granted, provided that the above 7 * copyright notice and this permission notice appear in all copies. 8 * 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. 16 */ 17 #ifndef MAN_H 18 #define MAN_H 19 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, 53 MAN_ft, 54 MAN_OP, 55 MAN_MAX 56 }; 57 58 enum man_type { 59 MAN_TEXT, 60 MAN_ELEM, 61 MAN_ROOT, 62 MAN_BLOCK, 63 MAN_HEAD, 64 MAN_BODY, 65 MAN_TAIL, 66 MAN_TBL, 67 MAN_EQN 68 }; 69 70 struct man_meta { 71 char *msec; /* `TH' section (1, 3p, etc.) */ 72 char *date; /* `TH' normalised date */ 73 char *vol; /* `TH' volume */ 74 char *title; /* `TH' title (e.g., FOO) */ 75 char *source; /* `TH' source (e.g., GNU) */ 76 }; 77 78 struct man_node { 79 struct man_node *parent; /* parent AST node */ 80 struct man_node *child; /* first child AST node */ 81 struct man_node *next; /* sibling AST node */ 82 struct man_node *prev; /* prior sibling AST node */ 83 int nchild; /* number children */ 84 int line; 85 int pos; 86 enum mant tok; /* tok or MAN__MAX if none */ 87 int flags; 88 #define MAN_VALID (1 << 0) /* has been validated */ 89 #define MAN_EOS (1 << 2) /* at sentence boundary */ 90 #define MAN_LINE (1 << 3) /* first macro/text on line */ 91 enum man_type type; /* AST node type */ 92 char *string; /* TEXT node argument */ 93 struct man_node *head; /* BLOCK node HEAD ptr */ 94 struct man_node *tail; /* BLOCK node TAIL ptr */ 95 struct man_node *body; /* BLOCK node BODY ptr */ 96 const struct tbl_span *span; /* TBL */ 97 const struct eqn *eqn; /* EQN */ 98 }; 99 100 /* Names of macros. Index is enum mant. */ 101 extern const char *const *man_macronames; 102 103 __BEGIN_DECLS 104 105 struct man; 106 107 const struct man_node *man_node(const struct man *); 108 const struct man_meta *man_meta(const struct man *); 109 const struct mparse *man_mparse(const struct man *); 110 111 __END_DECLS 112 113 #endif /*!MAN_H*/ 114