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