9dd448e6dd42d443fbdec4906363089b9b26aa4b
[dragonfly.git] / contrib / mdocml / mandoc.h
1 /*      $Id: mandoc.h,v 1.49 2011/01/06 13:45:47 kristaps Exp $ */
2 /*
3  * Copyright (c) 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 MANDOC_H
18 #define MANDOC_H
19
20 #define ASCII_NBRSP      31  /* non-breaking space */
21 #define ASCII_HYPH       30  /* breakable hyphen */
22
23 /*
24  * Status level.  This refers to both internal status (i.e., whilst
25  * running, when warnings/errors are reported) and an indicator of a
26  * threshold of when to halt (when said internal state exceeds the
27  * threshold).
28  */
29 enum    mandoclevel {
30         MANDOCLEVEL_OK = 0,
31         MANDOCLEVEL_RESERVED,
32         MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
33         MANDOCLEVEL_ERROR, /* input has been thrown away */
34         MANDOCLEVEL_FATAL, /* input is borked */
35         MANDOCLEVEL_BADARG, /* bad argument in invocation */
36         MANDOCLEVEL_SYSERR, /* system error */
37         MANDOCLEVEL_MAX
38 };
39
40 /*
41  * All possible things that can go wrong within a parse, be it libroff,
42  * libmdoc, or libman.
43  */
44 enum    mandocerr {
45         MANDOCERR_OK,
46
47         MANDOCERR_WARNING, /* ===== start of warnings ===== */
48
49         /* related to the prologue */
50         MANDOCERR_NOTITLE, /* no title in document */
51         MANDOCERR_UPPERCASE, /* document title should be all caps */
52         MANDOCERR_BADMSEC, /* unknown manual section */
53         MANDOCERR_BADDATE, /* cannot parse date argument */
54         MANDOCERR_PROLOGOOO, /* prologue macros out of order */
55         MANDOCERR_PROLOGREP, /* duplicate prologue macro */
56         MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
57         MANDOCERR_BADBODY, /* macro not allowed in body */
58
59         /* related to document structure */
60         MANDOCERR_SO, /* .so is fragile, better use ln(1) */
61         MANDOCERR_NAMESECFIRST, /* NAME section must come first */
62         MANDOCERR_BADNAMESEC, /* bad NAME section contents */
63         MANDOCERR_NONAME, /* manual name not yet set */
64         MANDOCERR_SECOOO, /* sections out of conventional order */
65         MANDOCERR_SECREP, /* duplicate section name */
66         MANDOCERR_SECMSEC, /* section not in conventional manual section */
67
68         /* related to macros and nesting */
69         MANDOCERR_MACROOBS, /* skipping obsolete macro */
70         MANDOCERR_IGNPAR, /* skipping paragraph macro */
71         MANDOCERR_SCOPENEST, /* blocks badly nested */
72         MANDOCERR_CHILD, /* child violates parent syntax */
73         MANDOCERR_NESTEDDISP, /* nested displays are not portable */
74         MANDOCERR_SCOPEREP, /* already in literal mode */
75
76         /* related to missing macro arguments */
77         MANDOCERR_MACROEMPTY, /* skipping empty macro */
78         MANDOCERR_ARGCWARN, /* argument count wrong */
79         MANDOCERR_DISPTYPE, /* missing display type */
80         MANDOCERR_LISTFIRST, /* list type must come first */
81         MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
82         MANDOCERR_FONTTYPE, /* missing font type */
83
84         /* related to bad macro arguments */
85         MANDOCERR_IGNARGV, /* skipping argument */
86         MANDOCERR_ARGVREP, /* duplicate argument */
87         MANDOCERR_DISPREP, /* duplicate display type */
88         MANDOCERR_LISTREP, /* duplicate list type */
89         MANDOCERR_BADATT, /* unknown AT&T UNIX version */
90         MANDOCERR_BADBOOL, /* bad Boolean value */
91         MANDOCERR_BADFONT, /* unknown font */
92         MANDOCERR_BADSTANDARD, /* unknown standard specifier */
93         MANDOCERR_BADWIDTH, /* bad width argument */
94
95         /* related to plain text */
96         MANDOCERR_NOBLANKLN, /* blank line in non-literal context */
97         MANDOCERR_BADTAB, /* tab in non-literal context */
98         MANDOCERR_EOLNSPACE, /* end of line whitespace */
99         MANDOCERR_BADCOMMENT, /* bad comment style */
100         MANDOCERR_BADESCAPE, /* unknown escape sequence */
101         MANDOCERR_BADQUOTE, /* unterminated quoted string */
102
103         /* related to tables */
104         MANDOCERR_TBLEXTRADAT, /* extra data cells */
105
106         MANDOCERR_ERROR, /* ===== start of errors ===== */
107
108         /* related to tables */
109         MANDOCERR_TBL, /* bad table syntax */
110         MANDOCERR_TBLOPT, /* bad table option */
111         MANDOCERR_TBLLAYOUT, /* bad table layout */
112         MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
113         MANDOCERR_TBLNODATA, /* no table data cells specified */
114         MANDOCERR_TBLIGNDATA, /* ignore data in cell */
115         MANDOCERR_TBLBLOCK, /* data block still open */
116
117         MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
118         MANDOCERR_BADCHAR, /* skipping bad character */
119         MANDOCERR_NOTEXT, /* skipping text before the first section header */
120         MANDOCERR_MACRO, /* skipping unknown macro */
121         MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
122         MANDOCERR_LINESCOPE, /* line scope broken */
123         MANDOCERR_ARGCOUNT, /* argument count wrong */
124         MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
125         MANDOCERR_SCOPEBROKEN, /* missing end of block */
126         MANDOCERR_SCOPEEXIT, /* scope open on exit */
127         MANDOCERR_UNAME, /* uname(3) system call failed */
128         /* FIXME: merge following with MANDOCERR_ARGCOUNT */
129         MANDOCERR_NOARGS, /* macro requires line argument(s) */
130         MANDOCERR_NOBODY, /* macro requires body argument(s) */
131         MANDOCERR_NOARGV, /* macro requires argument(s) */
132         MANDOCERR_LISTTYPE, /* missing list type */
133         MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
134         MANDOCERR_BODYLOST, /* body argument(s) will be lost */
135
136         MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
137
138         MANDOCERR_COLUMNS, /* column syntax is inconsistent */
139         MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
140         MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
141         MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
142         MANDOCERR_SYNTCHILD, /* child violates parent syntax */
143         MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
144         MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
145         MANDOCERR_NODOCBODY, /* no document body */
146         MANDOCERR_NODOCPROLOG, /* no document prologue */
147         MANDOCERR_MEM, /* static buffer exhausted */
148         MANDOCERR_MAX
149 };
150
151 struct  tbl {
152         char              tab; /* cell-separator */
153         char              decimal; /* decimal point */
154         int               linesize;
155         int               opts;
156 #define TBL_OPT_CENTRE   (1 << 0)
157 #define TBL_OPT_EXPAND   (1 << 1)
158 #define TBL_OPT_BOX      (1 << 2)
159 #define TBL_OPT_DBOX     (1 << 3)
160 #define TBL_OPT_ALLBOX   (1 << 4)
161 #define TBL_OPT_NOKEEP   (1 << 5)
162 #define TBL_OPT_NOSPACE  (1 << 6)
163         int               cols; /* number of columns */
164 };
165
166 enum    tbl_headt {
167         TBL_HEAD_DATA, /* plug in data from tbl_dat */
168         TBL_HEAD_VERT, /* vertical spacer */
169         TBL_HEAD_DVERT  /* double-vertical spacer */
170 };
171
172 /*
173  * The head of a table specifies all of its columns.  When formatting a
174  * tbl_span, iterate over these and plug in data from the tbl_span when
175  * appropriate, using tbl_cell as a guide to placement.
176  */
177 struct  tbl_head {
178         enum tbl_headt    pos;
179         int               ident; /* 0 <= unique id < cols */
180         struct tbl_head  *next;
181         struct tbl_head  *prev;
182 };
183
184 enum    tbl_cellt {
185         TBL_CELL_CENTRE, /* c, C */
186         TBL_CELL_RIGHT, /* r, R */
187         TBL_CELL_LEFT, /* l, L */
188         TBL_CELL_NUMBER, /* n, N */
189         TBL_CELL_SPAN, /* s, S */
190         TBL_CELL_LONG, /* a, A */
191         TBL_CELL_DOWN, /* ^ */
192         TBL_CELL_HORIZ, /* _, - */
193         TBL_CELL_DHORIZ, /* = */
194         TBL_CELL_VERT, /* | */
195         TBL_CELL_DVERT, /* || */
196         TBL_CELL_MAX
197 };
198
199 /*
200  * A cell in a layout row.
201  */
202 struct  tbl_cell {
203         struct tbl_cell  *next;
204         enum tbl_cellt    pos;
205         int               spacing;
206         int               flags;
207 #define TBL_CELL_TALIGN  (1 << 0) /* t, T */
208 #define TBL_CELL_BALIGN  (1 << 1) /* d, D */
209 #define TBL_CELL_BOLD    (1 << 2) /* fB, B, b */
210 #define TBL_CELL_ITALIC  (1 << 3) /* fI, I, i */
211 #define TBL_CELL_EQUAL   (1 << 4) /* e, E */
212 #define TBL_CELL_UP      (1 << 5) /* u, U */
213 #define TBL_CELL_WIGN    (1 << 6) /* z, Z */
214         struct tbl_head  *head;
215 };
216
217 /*
218  * A layout row.
219  */
220 struct  tbl_row {
221         struct tbl_row   *next;
222         struct tbl_cell  *first;
223         struct tbl_cell  *last;
224 };
225
226 enum    tbl_datt {
227         TBL_DATA_NONE,
228         TBL_DATA_DATA,
229         TBL_DATA_HORIZ,
230         TBL_DATA_DHORIZ,
231         TBL_DATA_NHORIZ,
232         TBL_DATA_NDHORIZ
233 };
234
235 /*
236  * A cell within a row of data.  The "string" field contains the actual
237  * string value that's in the cell.  The rest is layout.
238  */
239 struct  tbl_dat {
240         struct tbl_cell  *layout; /* layout cell: CAN BE NULL */
241         struct tbl_dat   *next;
242         char             *string;
243         enum tbl_datt     pos;
244 };
245
246 enum    tbl_spant {
247         TBL_SPAN_DATA, /* span consists of data */
248         TBL_SPAN_HORIZ, /* span is horizontal line */
249         TBL_SPAN_DHORIZ /* span is double horizontal line */
250 };
251
252 /*
253  * A row of data in a table.
254  */
255 struct  tbl_span {
256         struct tbl       *tbl;
257         struct tbl_head  *head;
258         struct tbl_row   *layout; /* layout row: CAN BE NULL */
259         struct tbl_dat   *first;
260         struct tbl_dat   *last;
261         int               flags;
262 #define TBL_SPAN_FIRST   (1 << 0)
263 #define TBL_SPAN_LAST    (1 << 1)
264         enum tbl_spant    pos;
265         struct tbl_span  *next;
266 };
267
268 /*
269  * Available registers (set in libroff, accessed elsewhere).
270  */
271 enum    regs {
272         REG_nS = 0,
273         REG__MAX
274 };
275
276 /*
277  * A register (struct reg) can consist of many types: this consists of
278  * normalised types from the original string form.
279  */
280 union   regval {
281         unsigned  u; /* unsigned integer */
282 };
283
284 /*
285  * A single register entity.  If "set" is zero, the value of the
286  * register should be the default one, which is per-register.  It's
287  * assumed that callers know which type in "v" corresponds to which
288  * register value.
289  */
290 struct  reg {
291         int               set; /* whether set or not */
292         union regval      v; /* parsed data */
293 };
294
295 /*
296  * The primary interface to setting register values is in libroff,
297  * although libmdoc and libman from time to time will manipulate
298  * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
299  */
300 struct  regset {
301         struct reg        regs[REG__MAX];
302 };
303
304 __BEGIN_DECLS
305
306 /*
307  * Callback function for warnings, errors, and fatal errors as they
308  * occur in the compilers libroff, libmdoc, and libman.
309  */
310 typedef int             (*mandocmsg)(enum mandocerr, void *,
311                                 int, int, const char *);
312
313 __END_DECLS
314
315 #endif /*!MANDOC_H*/