]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/mdocml/mandoc.h
Merge ^/head r319548 through r319778.
[FreeBSD/FreeBSD.git] / contrib / mdocml / mandoc.h
1 /*      $Id: mandoc.h,v 1.226 2017/06/08 18:11:22 schwarze Exp $ */
2 /*
3  * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
4  * Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org>
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 AUTHORS DISCLAIM ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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
19 #define ASCII_NBRSP      31  /* non-breaking space */
20 #define ASCII_HYPH       30  /* breakable hyphen */
21 #define ASCII_BREAK      29  /* breakable zero-width space */
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_STYLE, /* style suggestions */
32         MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
33         MANDOCLEVEL_ERROR, /* input has been thrown away */
34         MANDOCLEVEL_UNSUPP, /* input needs unimplemented features */
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_STYLE, /* ===== start of style suggestions ===== */
48
49         MANDOCERR_MACRO_USELESS, /* useless macro: macro */
50         MANDOCERR_BX, /* consider using OS macro: macro */
51         MANDOCERR_ER_ORDER, /* errnos out of order: Er ... */
52         MANDOCERR_ER_REP, /* duplicate errno: Er ... */
53         MANDOCERR_ND_DOT, /* description line ends with a full stop */
54
55         MANDOCERR_WARNING, /* ===== start of warnings ===== */
56
57         /* related to the prologue */
58         MANDOCERR_DT_NOTITLE, /* missing manual title, using UNTITLED: line */
59         MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */
60         MANDOCERR_TITLE_CASE, /* lower case character in document title */
61         MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
62         MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
63         MANDOCERR_DATE_MISSING, /* missing date, using today's date */
64         MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
65         MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
66         MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
67         MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */
68         MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */
69         MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macros */
70
71         /* related to document structure */
72         MANDOCERR_SO, /* .so is fragile, better use ln(1): so path */
73         MANDOCERR_DOC_EMPTY, /* no document body */
74         MANDOCERR_SEC_BEFORE, /* content before first section header: macro */
75         MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
76         MANDOCERR_NAMESEC_NONM, /* NAME section without Nm before Nd */
77         MANDOCERR_NAMESEC_NOND, /* NAME section without description */
78         MANDOCERR_NAMESEC_ND, /* description not at the end of NAME */
79         MANDOCERR_NAMESEC_BAD, /* bad NAME section content: macro */
80         MANDOCERR_NAMESEC_PUNCT, /* missing comma before name: Nm name */
81         MANDOCERR_ND_EMPTY, /* missing description line, using "" */
82         MANDOCERR_ND_LATE, /* description line outside NAME section */
83         MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */
84         MANDOCERR_SEC_REP, /* duplicate section title: Sh title */
85         MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */
86         MANDOCERR_XR_ORDER, /* unusual Xr order: ... after ... */
87         MANDOCERR_XR_PUNCT, /* unusual Xr punctuation: ... after ... */
88         MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */
89
90         /* related to macros and nesting */
91         MANDOCERR_MACRO_OBS, /* obsolete macro: macro */
92         MANDOCERR_MACRO_CALL, /* macro neither callable nor escaped: macro */
93         MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */
94         MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */
95         MANDOCERR_NS_SKIP, /* skipping no-space macro */
96         MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */
97         MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */
98         MANDOCERR_BL_MOVE, /* moving content out of list: macro */
99         MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
100         MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
101         MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
102         MANDOCERR_BLK_BLANK, /* skipping blank line in line scope */
103
104         /* related to missing arguments */
105         MANDOCERR_REQ_EMPTY, /* skipping empty request: request */
106         MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */
107         MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */
108         MANDOCERR_BLK_EMPTY, /* empty block: macro */
109         MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */
110         MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */
111         MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */
112         MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 6n */
113         MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
114         MANDOCERR_FO_NOHEAD, /* missing function name, using "": Fo */
115         MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
116         MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */
117         MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */
118         MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */
119         MANDOCERR_PF_SKIP, /* nothing follows prefix: Pf arg */
120         MANDOCERR_RS_EMPTY, /* empty reference block: Rs */
121         MANDOCERR_XR_NOSEC, /* missing section argument: Xr arg */
122         MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
123         MANDOCERR_OP_EMPTY, /* missing option string, using "": OP */
124         MANDOCERR_UR_NOHEAD, /* missing resource identifier, using "": UR */
125         MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
126
127         /* related to bad arguments */
128         MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
129         MANDOCERR_ARG_REP, /* duplicate argument: macro arg */
130         MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */
131         MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */
132         MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */
133         MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */
134         MANDOCERR_BL_COL, /* wrong number of cells */
135         MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */
136         MANDOCERR_FA_COMMA, /* comma in function argument: arg */
137         MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */
138         MANDOCERR_LB_BAD, /* unknown library name: Lb ... */
139         MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
140         MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
141         MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
142         MANDOCERR_TR_ODD, /* odd number of characters in request: tr char */
143
144         /* related to plain text */
145         MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
146         MANDOCERR_FI_TAB, /* tab in filled text */
147         MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
148         MANDOCERR_EOS, /* new sentence, new line */
149         MANDOCERR_COMMENT_BAD, /* bad comment style */
150         MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
151         MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
152
153         /* related to tables */
154         MANDOCERR_TBLLAYOUT_SPAN, /* tbl line starts with span */
155         MANDOCERR_TBLLAYOUT_DOWN, /* tbl column starts with span */
156         MANDOCERR_TBLLAYOUT_VERT, /* skipping vertical bar in tbl layout */
157
158         MANDOCERR_ERROR, /* ===== start of errors ===== */
159
160         /* related to tables */
161         MANDOCERR_TBLOPT_ALPHA, /* non-alphabetic character in tbl options */
162         MANDOCERR_TBLOPT_BAD, /* skipping unknown tbl option: option */
163         MANDOCERR_TBLOPT_NOARG, /* missing tbl option argument: option */
164         MANDOCERR_TBLOPT_ARGSZ, /* wrong tbl option argument size: option */
165         MANDOCERR_TBLLAYOUT_NONE, /* empty tbl layout */
166         MANDOCERR_TBLLAYOUT_CHAR, /* invalid character in tbl layout: char */
167         MANDOCERR_TBLLAYOUT_PAR, /* unmatched parenthesis in tbl layout */
168         MANDOCERR_TBLDATA_NONE, /* tbl without any data cells */
169         MANDOCERR_TBLDATA_SPAN, /* ignoring data in spanned tbl cell: data */
170         MANDOCERR_TBLDATA_EXTRA, /* ignoring extra tbl data cells: data */
171         MANDOCERR_TBLDATA_BLK, /* data block open at end of tbl: macro */
172
173         /* related to document structure and macros */
174         MANDOCERR_FILE, /* cannot open file */
175         MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
176         MANDOCERR_CHAR_BAD, /* skipping bad character: number */
177         MANDOCERR_MACRO, /* skipping unknown macro: macro */
178         MANDOCERR_REQ_INSEC, /* skipping insecure request: request */
179         MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
180         MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
181         MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */
182         MANDOCERR_RE_NOTOPEN, /* fewer RS blocks open, skipping: RE arg */
183         MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */
184         MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */
185
186         /* related to request and macro arguments */
187         MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
188         MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
189         MANDOCERR_BD_NOARG, /* skipping display without arguments: Bd */
190         MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
191         MANDOCERR_CE_NONUM, /* argument is not numeric, using 1: ce ... */
192         MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
193         MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
194         MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
195         MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
196         MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
197         MANDOCERR_SO_FAIL, /* .so request failed */
198         MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
199         MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
200         MANDOCERR_DIVZERO, /* divide by zero */
201
202         MANDOCERR_UNSUPP, /* ===== start of unsupported features ===== */
203
204         MANDOCERR_TOOLARGE, /* input too large */
205         MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */
206         MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */
207         MANDOCERR_TBLOPT_EQN, /* eqn delim option in tbl: arg */
208         MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */
209         MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */
210
211         MANDOCERR_MAX
212 };
213
214 struct  tbl_opts {
215         char              tab; /* cell-separator */
216         char              decimal; /* decimal point */
217         int               opts;
218 #define TBL_OPT_CENTRE   (1 << 0)
219 #define TBL_OPT_EXPAND   (1 << 1)
220 #define TBL_OPT_BOX      (1 << 2)
221 #define TBL_OPT_DBOX     (1 << 3)
222 #define TBL_OPT_ALLBOX   (1 << 4)
223 #define TBL_OPT_NOKEEP   (1 << 5)
224 #define TBL_OPT_NOSPACE  (1 << 6)
225 #define TBL_OPT_NOWARN   (1 << 7)
226         int               cols; /* number of columns */
227         int               lvert; /* width of left vertical line */
228         int               rvert; /* width of right vertical line */
229 };
230
231 enum    tbl_cellt {
232         TBL_CELL_CENTRE, /* c, C */
233         TBL_CELL_RIGHT, /* r, R */
234         TBL_CELL_LEFT, /* l, L */
235         TBL_CELL_NUMBER, /* n, N */
236         TBL_CELL_SPAN, /* s, S */
237         TBL_CELL_LONG, /* a, A */
238         TBL_CELL_DOWN, /* ^ */
239         TBL_CELL_HORIZ, /* _, - */
240         TBL_CELL_DHORIZ, /* = */
241         TBL_CELL_MAX
242 };
243
244 /*
245  * A cell in a layout row.
246  */
247 struct  tbl_cell {
248         struct tbl_cell  *next;
249         char             *wstr; /* min width represented as a string */
250         size_t            width; /* minimum column width */
251         size_t            spacing; /* to the right of the column */
252         int               vert; /* width of subsequent vertical line */
253         int               col; /* column number, starting from 0 */
254         int               flags;
255 #define TBL_CELL_TALIGN  (1 << 0) /* t, T */
256 #define TBL_CELL_BALIGN  (1 << 1) /* d, D */
257 #define TBL_CELL_BOLD    (1 << 2) /* fB, B, b */
258 #define TBL_CELL_ITALIC  (1 << 3) /* fI, I, i */
259 #define TBL_CELL_EQUAL   (1 << 4) /* e, E */
260 #define TBL_CELL_UP      (1 << 5) /* u, U */
261 #define TBL_CELL_WIGN    (1 << 6) /* z, Z */
262 #define TBL_CELL_WMAX    (1 << 7) /* x, X */
263         enum tbl_cellt    pos;
264 };
265
266 /*
267  * A layout row.
268  */
269 struct  tbl_row {
270         struct tbl_row   *next;
271         struct tbl_cell  *first;
272         struct tbl_cell  *last;
273         int               vert; /* width of left vertical line */
274 };
275
276 enum    tbl_datt {
277         TBL_DATA_NONE, /* has no data */
278         TBL_DATA_DATA, /* consists of data/string */
279         TBL_DATA_HORIZ, /* horizontal line */
280         TBL_DATA_DHORIZ, /* double-horizontal line */
281         TBL_DATA_NHORIZ, /* squeezed horizontal line */
282         TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
283 };
284
285 /*
286  * A cell within a row of data.  The "string" field contains the actual
287  * string value that's in the cell.  The rest is layout.
288  */
289 struct  tbl_dat {
290         struct tbl_cell  *layout; /* layout cell */
291         struct tbl_dat   *next;
292         char             *string; /* data (NULL if not TBL_DATA_DATA) */
293         int               spans; /* how many spans follow */
294         int               block; /* T{ text block T} */
295         enum tbl_datt     pos;
296 };
297
298 enum    tbl_spant {
299         TBL_SPAN_DATA, /* span consists of data */
300         TBL_SPAN_HORIZ, /* span is horizontal line */
301         TBL_SPAN_DHORIZ /* span is double horizontal line */
302 };
303
304 /*
305  * A row of data in a table.
306  */
307 struct  tbl_span {
308         struct tbl_opts  *opts;
309         struct tbl_row   *layout; /* layout row */
310         struct tbl_dat   *first;
311         struct tbl_dat   *last;
312         struct tbl_span  *prev;
313         struct tbl_span  *next;
314         int               line; /* parse line */
315         enum tbl_spant    pos;
316 };
317
318 enum    eqn_boxt {
319         EQN_ROOT, /* root of parse tree */
320         EQN_TEXT, /* text (number, variable, whatever) */
321         EQN_SUBEXPR, /* nested `eqn' subexpression */
322         EQN_LIST, /* list (braces, etc.) */
323         EQN_LISTONE, /* singleton list */
324         EQN_PILE, /* vertical pile */
325         EQN_MATRIX /* pile of piles */
326 };
327
328 enum    eqn_fontt {
329         EQNFONT_NONE = 0,
330         EQNFONT_ROMAN,
331         EQNFONT_BOLD,
332         EQNFONT_FAT,
333         EQNFONT_ITALIC,
334         EQNFONT__MAX
335 };
336
337 enum    eqn_post {
338         EQNPOS_NONE = 0,
339         EQNPOS_SUP,
340         EQNPOS_SUBSUP,
341         EQNPOS_SUB,
342         EQNPOS_TO,
343         EQNPOS_FROM,
344         EQNPOS_FROMTO,
345         EQNPOS_OVER,
346         EQNPOS_SQRT,
347         EQNPOS__MAX
348 };
349
350 enum    eqn_pilet {
351         EQNPILE_NONE = 0,
352         EQNPILE_PILE,
353         EQNPILE_CPILE,
354         EQNPILE_RPILE,
355         EQNPILE_LPILE,
356         EQNPILE_COL,
357         EQNPILE_CCOL,
358         EQNPILE_RCOL,
359         EQNPILE_LCOL,
360         EQNPILE__MAX
361 };
362
363  /*
364  * A "box" is a parsed mathematical expression as defined by the eqn.7
365  * grammar.
366  */
367 struct  eqn_box {
368         int               size; /* font size of expression */
369 #define EQN_DEFSIZE       INT_MIN
370         enum eqn_boxt     type; /* type of node */
371         struct eqn_box   *first; /* first child node */
372         struct eqn_box   *last; /* last child node */
373         struct eqn_box   *next; /* node sibling */
374         struct eqn_box   *prev; /* node sibling */
375         struct eqn_box   *parent; /* node sibling */
376         char             *text; /* text (or NULL) */
377         char             *left; /* fence left-hand */
378         char             *right; /* fence right-hand */
379         char             *top; /* expression over-symbol */
380         char             *bottom; /* expression under-symbol */
381         size_t            args; /* arguments in parent */
382         size_t            expectargs; /* max arguments in parent */
383         enum eqn_post     pos; /* position of next box */
384         enum eqn_fontt    font; /* font of box */
385         enum eqn_pilet    pile; /* equation piling */
386 };
387
388 /*
389  * An equation consists of a tree of expressions starting at a given
390  * line and position.
391  */
392 struct  eqn {
393         char             *name; /* identifier (or NULL) */
394         struct eqn_box   *root; /* root mathematical expression */
395         int               ln; /* invocation line */
396         int               pos; /* invocation position */
397 };
398
399 /*
400  * Parse options.
401  */
402 #define MPARSE_MDOC     1  /* assume -mdoc */
403 #define MPARSE_MAN      2  /* assume -man */
404 #define MPARSE_SO       4  /* honour .so requests */
405 #define MPARSE_QUICK    8  /* abort the parse early */
406 #define MPARSE_UTF8     16 /* accept UTF-8 input */
407 #define MPARSE_LATIN1   32 /* accept ISO-LATIN-1 input */
408
409 enum    mandoc_esc {
410         ESCAPE_ERROR = 0, /* bail! unparsable escape */
411         ESCAPE_IGNORE, /* escape to be ignored */
412         ESCAPE_SPECIAL, /* a regular special character */
413         ESCAPE_FONT, /* a generic font mode */
414         ESCAPE_FONTBOLD, /* bold font mode */
415         ESCAPE_FONTITALIC, /* italic font mode */
416         ESCAPE_FONTBI, /* bold italic font mode */
417         ESCAPE_FONTROMAN, /* roman font mode */
418         ESCAPE_FONTPREV, /* previous font mode */
419         ESCAPE_NUMBERED, /* a numbered glyph */
420         ESCAPE_UNICODE, /* a unicode codepoint */
421         ESCAPE_NOSPACE, /* suppress space if the last on a line */
422         ESCAPE_HORIZ, /* horizontal movement */
423         ESCAPE_HLINE, /* horizontal line drawing */
424         ESCAPE_SKIPCHAR, /* skip the next character */
425         ESCAPE_OVERSTRIKE /* overstrike all chars in the argument */
426 };
427
428 typedef void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
429                         const char *, int, int, const char *);
430
431
432 struct  mparse;
433 struct  roff_man;
434
435 enum mandoc_esc   mandoc_escape(const char **, const char **, int *);
436 void              mchars_alloc(void);
437 void              mchars_free(void);
438 int               mchars_num2char(const char *, size_t);
439 const char       *mchars_uc2str(int);
440 int               mchars_num2uc(const char *, size_t);
441 int               mchars_spec2cp(const char *, size_t);
442 const char       *mchars_spec2str(const char *, size_t, size_t *);
443 struct mparse    *mparse_alloc(int, enum mandoclevel, mandocmsg, const char *);
444 void              mparse_free(struct mparse *);
445 void              mparse_keep(struct mparse *);
446 int               mparse_open(struct mparse *, const char *);
447 enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
448 enum mandoclevel  mparse_readmem(struct mparse *, void *, size_t,
449                         const char *);
450 void              mparse_reset(struct mparse *);
451 void              mparse_result(struct mparse *,
452                         struct roff_man **, char **);
453 const char       *mparse_getkeep(const struct mparse *);
454 const char       *mparse_strerror(enum mandocerr);
455 const char       *mparse_strlevel(enum mandoclevel);
456 void              mparse_updaterc(struct mparse *, enum mandoclevel *);