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