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