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