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