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