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