]> git.cameronkatri.com Git - mandoc.git/blob - man.h
Remove `am', `ami', `de', `dei', and `.' from -man, as they're now in the roff prepro...
[mandoc.git] / man.h
1 /* $Id: man.h,v 1.32 2010/05/15 22:44:04 kristaps Exp $ */
2 /*
3 * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
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 #include <time.h>
21
22 enum mant {
23 MAN_br = 0,
24 MAN_TH,
25 MAN_SH,
26 MAN_SS,
27 MAN_TP,
28 MAN_LP,
29 MAN_PP,
30 MAN_P,
31 MAN_IP,
32 MAN_HP,
33 MAN_SM,
34 MAN_SB,
35 MAN_BI,
36 MAN_IB,
37 MAN_BR,
38 MAN_RB,
39 MAN_R,
40 MAN_B,
41 MAN_I,
42 MAN_IR,
43 MAN_RI,
44 MAN_na,
45 MAN_i,
46 MAN_sp,
47 MAN_nf,
48 MAN_fi,
49 MAN_r,
50 MAN_RE,
51 MAN_RS,
52 MAN_DT,
53 MAN_UC,
54 MAN_PD,
55 MAN_Sp,
56 MAN_Vb,
57 MAN_Ve,
58 MAN_MAX
59 };
60
61 enum man_type {
62 MAN_TEXT,
63 MAN_ELEM,
64 MAN_ROOT,
65 MAN_BLOCK,
66 MAN_HEAD,
67 MAN_BODY
68 };
69
70 struct man_meta {
71 char *msec;
72 time_t date;
73 char *vol;
74 char *title;
75 char *source;
76 };
77
78 struct man_node {
79 struct man_node *parent;
80 struct man_node *child;
81 struct man_node *next;
82 struct man_node *prev;
83 int nchild;
84 int line;
85 int pos;
86 enum mant tok;
87 int flags;
88 #define MAN_VALID (1 << 0)
89 #define MAN_ACTED (1 << 1)
90 #define MAN_EOS (1 << 2)
91 enum man_type type;
92 char *string;
93 struct man_node *head;
94 struct man_node *body;
95 };
96
97 #define MAN_IGN_MACRO (1 << 0)
98 #define MAN_IGN_ESCAPE (1 << 2)
99
100 extern const char *const *man_macronames;
101
102 struct man_cb {
103 int (*man_warn)(void *, int, int, const char *);
104 int (*man_err)(void *, int, int, const char *);
105 };
106
107 __BEGIN_DECLS
108
109 struct man;
110
111 void man_free(struct man *);
112 struct man *man_alloc(void *, int, const struct man_cb *);
113 void man_reset(struct man *);
114 int man_parseln(struct man *, int, char *buf);
115 int man_endparse(struct man *);
116
117 const struct man_node *man_node(const struct man *);
118 const struct man_meta *man_meta(const struct man *);
119
120 __END_DECLS
121
122 #endif /*!MAN_H*/