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