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