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