Import mdocml-1.13.1
[dragonfly.git] / contrib / mdocml / man.h
CommitLineData
070c62a6 1/* $Id: man.h,v 1.65 2014/06/20 23:02:31 schwarze Exp $ */
80387638 2/*
60e1e752 3 * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
070c62a6 4 * Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
80387638
SW
5 *
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.
9 *
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.
17 */
18#ifndef MAN_H
19#define MAN_H
20
80387638
SW
21enum 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,
54 MAN_ft,
36342e81 55 MAN_OP,
f88b6c16
FF
56 MAN_EX,
57 MAN_EE,
7888c61d
FF
58 MAN_UR,
59 MAN_UE,
070c62a6 60 MAN_ll,
80387638
SW
61 MAN_MAX
62};
63
80387638
SW
64enum man_type {
65 MAN_TEXT,
66 MAN_ELEM,
67 MAN_ROOT,
68 MAN_BLOCK,
69 MAN_HEAD,
70 MAN_BODY,
60e1e752
SW
71 MAN_TAIL,
72 MAN_TBL,
73 MAN_EQN
80387638
SW
74};
75
80387638
SW
76struct man_meta {
77 char *msec; /* `TH' section (1, 3p, etc.) */
60e1e752 78 char *date; /* `TH' normalised date */
80387638
SW
79 char *vol; /* `TH' volume */
80 char *title; /* `TH' title (e.g., FOO) */
81 char *source; /* `TH' source (e.g., GNU) */
070c62a6 82 int hasbody; /* document is not empty */
80387638
SW
83};
84
80387638
SW
85struct man_node {
86 struct man_node *parent; /* parent AST node */
87 struct man_node *child; /* first child AST node */
88 struct man_node *next; /* sibling AST node */
89 struct man_node *prev; /* prior sibling AST node */
90 int nchild; /* number children */
91 int line;
92 int pos;
93 enum mant tok; /* tok or MAN__MAX if none */
94 int flags;
95#define MAN_VALID (1 << 0) /* has been validated */
96#define MAN_EOS (1 << 2) /* at sentence boundary */
60e1e752 97#define MAN_LINE (1 << 3) /* first macro/text on line */
80387638
SW
98 enum man_type type; /* AST node type */
99 char *string; /* TEXT node argument */
100 struct man_node *head; /* BLOCK node HEAD ptr */
60e1e752 101 struct man_node *tail; /* BLOCK node TAIL ptr */
80387638
SW
102 struct man_node *body; /* BLOCK node BODY ptr */
103 const struct tbl_span *span; /* TBL */
60e1e752 104 const struct eqn *eqn; /* EQN */
80387638
SW
105};
106
60e1e752 107/* Names of macros. Index is enum mant. */
80387638
SW
108extern const char *const *man_macronames;
109
110__BEGIN_DECLS
111
112struct man;
113
80387638
SW
114const struct man_node *man_node(const struct man *);
115const struct man_meta *man_meta(const struct man *);
36342e81 116const struct mparse *man_mparse(const struct man *);
070c62a6 117void man_deroff(char **, const struct man_node *);
80387638
SW
118
119__END_DECLS
120
121#endif /*!MAN_H*/