Annotation of src/usr.bin/mandoc/man.h, Revision 1.31
1.31 ! schwarze 1: /* $Id: man.h,v 1.30 2010/11/29 02:26:45 schwarze Exp $ */
1.1 kristaps 2: /*
1.25 schwarze 3: * Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.2 schwarze 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.
1.1 kristaps 16: */
17: #ifndef MAN_H
18: #define MAN_H
19:
1.28 schwarze 20: /*
21: * What follows is a list of ALL possible macros.
22: */
1.14 schwarze 23: enum mant {
24: MAN_br = 0,
25: MAN_TH,
26: MAN_SH,
27: MAN_SS,
28: MAN_TP,
29: MAN_LP,
30: MAN_PP,
31: MAN_P,
32: MAN_IP,
33: MAN_HP,
34: MAN_SM,
35: MAN_SB,
36: MAN_BI,
37: MAN_IB,
38: MAN_BR,
39: MAN_RB,
40: MAN_R,
41: MAN_B,
42: MAN_I,
43: MAN_IR,
44: MAN_RI,
45: MAN_na,
46: MAN_sp,
47: MAN_nf,
48: MAN_fi,
49: MAN_RE,
50: MAN_RS,
51: MAN_DT,
52: MAN_UC,
53: MAN_PD,
1.21 schwarze 54: MAN_AT,
1.25 schwarze 55: MAN_in,
1.27 schwarze 56: MAN_TS,
57: MAN_TE,
1.29 schwarze 58: MAN_ft,
1.21 schwarze 59: MAN_MAX
1.14 schwarze 60: };
1.1 kristaps 61:
1.28 schwarze 62: /*
63: * Type of a syntax node.
64: */
1.1 kristaps 65: enum man_type {
66: MAN_TEXT,
67: MAN_ELEM,
1.7 schwarze 68: MAN_ROOT,
69: MAN_BLOCK,
70: MAN_HEAD,
71: MAN_BODY
1.1 kristaps 72: };
73:
1.28 schwarze 74: /*
75: * Information from prologue.
76: */
1.1 kristaps 77: struct man_meta {
1.28 schwarze 78: char *msec; /* `TH' section (1, 3p, etc.) */
79: time_t date; /* `TH' normalised date */
80: char *rawdate; /* raw `TH' date */
81: char *vol; /* `TH' volume */
82: char *title; /* `TH' title (e.g., FOO) */
83: char *source; /* `TH' source (e.g., GNU) */
1.1 kristaps 84: };
85:
1.28 schwarze 86: union man_data {
87: struct tbl *TS;
88: };
89:
90: /*
91: * Single node in tree-linked AST.
92: */
1.1 kristaps 93: struct man_node {
1.28 schwarze 94: struct man_node *parent; /* parent AST node */
95: struct man_node *child; /* first child AST node */
96: struct man_node *next; /* sibling AST node */
97: struct man_node *prev; /* prior sibling AST node */
98: int nchild; /* number children */
1.1 kristaps 99: int line;
100: int pos;
1.28 schwarze 101: enum mant tok; /* tok or MAN__MAX if none */
1.1 kristaps 102: int flags;
1.28 schwarze 103: #define MAN_VALID (1 << 0) /* has been validated */
104: #define MAN_ACTED (1 << 1) /* has been acted upon */
105: #define MAN_EOS (1 << 2) /* at sentence boundary */
106: enum man_type type; /* AST node type */
107: char *string; /* TEXT node argument */
108: struct man_node *head; /* BLOCK node HEAD ptr */
109: struct man_node *body; /* BLOCK node BODY ptr */
110: union man_data data;
1.1 kristaps 111: };
112:
1.28 schwarze 113: /*
114: * Names of macros. Index is enum mant. Indexing into this returns
115: * the normalised name, e.g., man_macronames[MAN_SH] -> "SH".
116: */
1.1 kristaps 117: extern const char *const *man_macronames;
118:
119: __BEGIN_DECLS
120:
121: struct man;
122:
123: void man_free(struct man *);
1.26 schwarze 124: struct man *man_alloc(struct regset *, void *, mandocmsg);
1.12 schwarze 125: void man_reset(struct man *);
1.20 schwarze 126: int man_parseln(struct man *, int, char *, int);
1.1 kristaps 127: int man_endparse(struct man *);
128:
129: const struct man_node *man_node(const struct man *);
130: const struct man_meta *man_meta(const struct man *);
131:
132: __END_DECLS
133:
134: #endif /*!MAN_H*/