release 1.14.6

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index 31d5444afe385e0222f86c5a09cbfd1bb2ecb87e..9837ff2ae9dff07b10534c2ba89981c0803754f0 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,24 +1,27 @@
-/*     $Id: mandoc.h,v 1.81 2011/07/18 14:30:51 kristaps Exp $ */
+/* $Id: mandoc.h,v 1.274 2021/08/14 13:53:08 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2012-2021 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>

  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
  *
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
  *

- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES

  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR

  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

+ *
+ * Error handling, escape sequence, and character utilities.
+ * Can be used by all code in the mandoc package.

  */
  */

-#ifndef MANDOC_H
-#define MANDOC_H

 
 #define ASCII_NBRSP     31  /* non-breaking space */
 #define        ASCII_HYPH       30  /* breakable hyphen */
 
 #define ASCII_NBRSP     31  /* non-breaking space */
 #define        ASCII_HYPH       30  /* breakable hyphen */

+#define        ASCII_BREAK      29  /* breakable zero-width space */

 
 /*
  * Status level.  This refers to both internal status (i.e., whilst
 
 /*
  * Status level.  This refers to both internal status (i.e., whilst


@@ -28,10 +31,10 @@
  */
 enum   mandoclevel {
        MANDOCLEVEL_OK = 0,
  */
 enum   mandoclevel {
        MANDOCLEVEL_OK = 0,

-       MANDOCLEVEL_RESERVED,
+       MANDOCLEVEL_STYLE, /* style suggestions */

        MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
        MANDOCLEVEL_ERROR, /* input has been thrown away */
        MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
        MANDOCLEVEL_ERROR, /* input has been thrown away */

-       MANDOCLEVEL_FATAL, /* input is borked */
+       MANDOCLEVEL_UNSUPP, /* input needs unimplemented features */

        MANDOCLEVEL_BADARG, /* bad argument in invocation */
        MANDOCLEVEL_SYSERR, /* system error */
        MANDOCLEVEL_MAX
        MANDOCLEVEL_BADARG, /* bad argument in invocation */
        MANDOCLEVEL_SYSERR, /* system error */
        MANDOCLEVEL_MAX


@@ -44,305 +47,283 @@ enum      mandoclevel {
 enum   mandocerr {
        MANDOCERR_OK,
 
 enum   mandocerr {
        MANDOCERR_OK,
 

+       MANDOCERR_BASE, /* ===== start of base system conventions ===== */
+
+       MANDOCERR_MDOCDATE, /* Mdocdate found: Dd ... */
+       MANDOCERR_MDOCDATE_MISSING, /* Mdocdate missing: Dd ... */
+       MANDOCERR_ARCH_BAD,  /* unknown architecture: Dt ... arch */
+       MANDOCERR_OS_ARG,  /* operating system explicitly specified: Os ... */
+       MANDOCERR_RCS_MISSING, /* RCS id missing */
+
+       MANDOCERR_STYLE, /* ===== start of style suggestions ===== */
+
+       MANDOCERR_DATE_LEGACY, /* legacy man(7) date format: Dd ... */
+       MANDOCERR_DATE_NORM, /* normalizing date format to: ... */
+       MANDOCERR_TITLE_CASE, /* lower case character in document title */
+       MANDOCERR_RCS_REP, /* duplicate RCS id: ... */
+       MANDOCERR_SEC_TYPO,  /* possible typo in section name: Sh ... */
+       MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
+       MANDOCERR_MACRO_USELESS, /* useless macro: macro */
+       MANDOCERR_BX, /* consider using OS macro: macro */
+       MANDOCERR_ER_ORDER, /* errnos out of order: Er ... */
+       MANDOCERR_ER_REP, /* duplicate errno: Er ... */
+       MANDOCERR_XR_BAD,  /* referenced manual not found: Xr name sec */
+       MANDOCERR_DELIM, /* trailing delimiter: macro ... */
+       MANDOCERR_DELIM_NB, /* no blank before trailing delimiter: macro ... */
+       MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
+       MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
+       MANDOCERR_TEXT_LONG, /* input text line longer than 80 bytes */
+       MANDOCERR_DASHDASH, /* verbatim "--", maybe consider using \(em */
+       MANDOCERR_FUNC, /* function name without markup: name() */
+       MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
+       MANDOCERR_COMMENT_BAD, /* bad comment style */
+

        MANDOCERR_WARNING, /* ===== start of warnings ===== */
 
        /* related to the prologue */
        MANDOCERR_WARNING, /* ===== start of warnings ===== */
 
        /* related to the prologue */

-       MANDOCERR_NOTITLE, /* no title in document */
-       MANDOCERR_UPPERCASE, /* document title should be all caps */
-       MANDOCERR_BADMSEC, /* unknown manual section */
-       MANDOCERR_NODATE, /* date missing, using today's date */
-       MANDOCERR_BADDATE, /* cannot parse date, using it verbatim */
-       MANDOCERR_PROLOGOOO, /* prologue macros out of order */
-       MANDOCERR_PROLOGREP, /* duplicate prologue macro */
-       MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
-       MANDOCERR_BADBODY, /* macro not allowed in body */
+       MANDOCERR_DT_NOTITLE, /* missing manual title, using UNTITLED: line */
+       MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */
+       MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
+       MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
+       MANDOCERR_MSEC_FILE, /* filename/section mismatch: ... */
+       MANDOCERR_DATE_MISSING, /* missing date, using "": [macro] */
+       MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
+       MANDOCERR_DATE_FUTURE, /* date in the future, using it anyway: date */
+       MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
+       MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */
+       MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macros */

 
        /* related to document structure */
 
        /* related to document structure */

-       MANDOCERR_SO, /* .so is fragile, better use ln(1) */
-       MANDOCERR_NAMESECFIRST, /* NAME section must come first */
-       MANDOCERR_BADNAMESEC, /* bad NAME section contents */
-       MANDOCERR_NONAME, /* manual name not yet set */
-       MANDOCERR_SECOOO, /* sections out of conventional order */
-       MANDOCERR_SECREP, /* duplicate section name */
-       MANDOCERR_SECMSEC, /* section not in conventional manual section */
+       MANDOCERR_SO, /* .so is fragile, better use ln(1): so path */
+       MANDOCERR_DOC_EMPTY, /* no document body */
+       MANDOCERR_SEC_BEFORE, /* content before first section header: macro */
+       MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
+       MANDOCERR_NAMESEC_NONM, /* NAME section without Nm before Nd */
+       MANDOCERR_NAMESEC_NOND, /* NAME section without description */
+       MANDOCERR_NAMESEC_ND, /* description not at the end of NAME */
+       MANDOCERR_NAMESEC_BAD, /* bad NAME section content: macro */
+       MANDOCERR_NAMESEC_PUNCT, /* missing comma before name: Nm name */
+       MANDOCERR_ND_EMPTY, /* missing description line, using "" */
+       MANDOCERR_ND_LATE, /* description line outside NAME section */
+       MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */
+       MANDOCERR_SEC_REP, /* duplicate section title: Sh title */
+       MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */
+       MANDOCERR_XR_SELF,  /* cross reference to self: Xr name sec */
+       MANDOCERR_XR_ORDER, /* unusual Xr order: ... after ... */
+       MANDOCERR_XR_PUNCT, /* unusual Xr punctuation: ... after ... */
+       MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */

 
        /* related to macros and nesting */
 
        /* related to macros and nesting */

-       MANDOCERR_MACROOBS, /* skipping obsolete macro */
-       MANDOCERR_IGNPAR, /* skipping paragraph macro */
-       MANDOCERR_IGNNS, /* skipping no-space macro */
-       MANDOCERR_SCOPENEST, /* blocks badly nested */
-       MANDOCERR_CHILD, /* child violates parent syntax */
-       MANDOCERR_NESTEDDISP, /* nested displays are not portable */
-       MANDOCERR_SCOPEREP, /* already in literal mode */
-       MANDOCERR_LINESCOPE, /* line scope broken */
-
-       /* related to missing macro arguments */
-       MANDOCERR_MACROEMPTY, /* skipping empty macro */
-       MANDOCERR_ARGCWARN, /* argument count wrong */
-       MANDOCERR_DISPTYPE, /* missing display type */
-       MANDOCERR_LISTFIRST, /* list type must come first */
-       MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
-       MANDOCERR_FONTTYPE, /* missing font type */
-       MANDOCERR_WNOSCOPE, /* skipping end of block that is not open */
-
-       /* related to bad macro arguments */
-       MANDOCERR_IGNARGV, /* skipping argument */
-       MANDOCERR_ARGVREP, /* duplicate argument */
-       MANDOCERR_DISPREP, /* duplicate display type */
-       MANDOCERR_LISTREP, /* duplicate list type */
-       MANDOCERR_BADATT, /* unknown AT&T UNIX version */
-       MANDOCERR_BADBOOL, /* bad Boolean value */
-       MANDOCERR_BADFONT, /* unknown font */
-       MANDOCERR_BADSTANDARD, /* unknown standard specifier */
-       MANDOCERR_BADWIDTH, /* bad width argument */
+       MANDOCERR_MACRO_OBS, /* obsolete macro: macro */
+       MANDOCERR_MACRO_CALL, /* macro neither callable nor escaped: macro */
+       MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */
+       MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */
+       MANDOCERR_NS_SKIP, /* skipping no-space macro */
+       MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */
+       MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */
+       MANDOCERR_BL_MOVE, /* moving content out of list: macro */
+       MANDOCERR_TA_LINE, /* first macro on line: Ta */
+       MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
+       MANDOCERR_BLK_BLANK, /* skipping blank line in line scope */
+
+       /* related to missing arguments */
+       MANDOCERR_REQ_EMPTY, /* skipping empty request: request */
+       MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */
+       MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */
+       MANDOCERR_BLK_EMPTY, /* empty block: macro */
+       MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */
+       MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */
+       MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */
+       MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 6n */
+       MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
+       MANDOCERR_FO_NOHEAD, /* missing function name, using "": Fo */
+       MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
+       MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */
+       MANDOCERR_IT_NOARG, /* missing argument, using next line: Bl -c It */
+       MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */
+       MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */
+       MANDOCERR_PF_SKIP, /* nothing follows prefix: Pf arg */
+       MANDOCERR_RS_EMPTY, /* empty reference block: Rs */
+       MANDOCERR_XR_NOSEC, /* missing section argument: Xr arg */
+       MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
+       MANDOCERR_OP_EMPTY, /* missing option string, using "": OP */
+       MANDOCERR_UR_NOHEAD, /* missing resource identifier, using "": UR */
+       MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
+
+       /* related to bad arguments */
+       MANDOCERR_ARG_REP, /* duplicate argument: macro arg */
+       MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */
+       MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */
+       MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */
+       MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */
+       MANDOCERR_BL_COL, /* wrong number of cells */
+       MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */
+       MANDOCERR_FA_COMMA, /* comma in function argument: arg */
+       MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */
+       MANDOCERR_LB_BAD, /* unknown library name: Lb ... */
+       MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
+       MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
+       MANDOCERR_CHAR_FONT, /* argument contains two font escapes */
+       MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
+       MANDOCERR_TR_ODD, /* odd number of characters in request: tr char */

 
        /* related to plain text */
 
        /* related to plain text */

-       MANDOCERR_NOBLANKLN, /* blank line in non-literal context */
-       MANDOCERR_BADTAB, /* tab in non-literal context */
-       MANDOCERR_EOLNSPACE, /* end of line whitespace */
-       MANDOCERR_BADCOMMENT, /* bad comment style */
-       MANDOCERR_BADESCAPE, /* unknown escape sequence */
-       MANDOCERR_BADQUOTE, /* unterminated quoted string */
+       MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
+       MANDOCERR_FI_TAB, /* tab in filled text */
+       MANDOCERR_EOS, /* new sentence, new line */
+       MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
+       MANDOCERR_ESC_UNDEF, /* undefined escape, printing literally: char */
+       MANDOCERR_STR_UNDEF, /* undefined string, using "": name */

 
 

-       /* related to equations */
-       MANDOCERR_EQNQUOTE, /* unexpected literal in equation */
+       /* related to tables */
+       MANDOCERR_TBLLAYOUT_SPAN, /* tbl line starts with span */
+       MANDOCERR_TBLLAYOUT_DOWN, /* tbl column starts with span */
+       MANDOCERR_TBLLAYOUT_VERT, /* skipping vertical bar in tbl layout */

 
        MANDOCERR_ERROR, /* ===== start of errors ===== */
 
 
        MANDOCERR_ERROR, /* ===== start of errors ===== */
 

-       /* related to equations */
-       MANDOCERR_EQNARGS, /* bad equation macro arguments */
-       MANDOCERR_EQNNEST, /* too many nested equation defines */
-

        /* related to tables */
        /* related to tables */

-       MANDOCERR_TBL, /* bad table syntax */
-       MANDOCERR_TBLOPT, /* bad table option */
-       MANDOCERR_TBLLAYOUT, /* bad table layout */
-       MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
-       MANDOCERR_TBLNODATA, /* no table data cells specified */
-       MANDOCERR_TBLIGNDATA, /* ignore data in cell */
-       MANDOCERR_TBLBLOCK, /* data block still open */
-       MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */
-
+       MANDOCERR_TBLOPT_ALPHA, /* non-alphabetic character in tbl options */
+       MANDOCERR_TBLOPT_BAD, /* skipping unknown tbl option: option */
+       MANDOCERR_TBLOPT_NOARG, /* missing tbl option argument: option */
+       MANDOCERR_TBLOPT_ARGSZ, /* wrong tbl option argument size: option */
+       MANDOCERR_TBLLAYOUT_NONE, /* empty tbl layout */
+       MANDOCERR_TBLLAYOUT_CHAR, /* invalid character in tbl layout: char */
+       MANDOCERR_TBLLAYOUT_PAR, /* unmatched parenthesis in tbl layout */
+       MANDOCERR_TBLLAYOUT_SPC, /* ignoring excessive spacing in tbl layout */
+       MANDOCERR_TBLDATA_NONE, /* tbl without any data cells */
+       MANDOCERR_TBLDATA_SPAN, /* ignoring data in spanned tbl cell: data */
+       MANDOCERR_TBLDATA_EXTRA, /* ignoring extra tbl data cells: data */
+       MANDOCERR_TBLDATA_BLK, /* data block open at end of tbl: macro */
+
+       /* related to document structure and macros */
+       MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
+       MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */

        MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
        MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */

-       MANDOCERR_BADCHAR, /* skipping bad character */
-       MANDOCERR_NAMESC, /* escaped character not allowed in a name */
-       MANDOCERR_NOTEXT, /* skipping text before the first section header */
-       MANDOCERR_MACRO, /* skipping unknown macro */
-       MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
-       MANDOCERR_ARGCOUNT, /* argument count wrong */
-       MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
-       MANDOCERR_SCOPEBROKEN, /* missing end of block */
-       MANDOCERR_SCOPEEXIT, /* scope open on exit */
-       MANDOCERR_UNAME, /* uname(3) system call failed */
-       /* FIXME: merge following with MANDOCERR_ARGCOUNT */
-       MANDOCERR_NOARGS, /* macro requires line argument(s) */
-       MANDOCERR_NOBODY, /* macro requires body argument(s) */
-       MANDOCERR_NOARGV, /* macro requires argument(s) */
-       MANDOCERR_LISTTYPE, /* missing list type */
-       MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
-       MANDOCERR_BODYLOST, /* body argument(s) will be lost */
+       MANDOCERR_CHAR_BAD, /* skipping bad character: number */
+       MANDOCERR_MACRO, /* skipping unknown macro: macro */
+       MANDOCERR_REQ_NOMAC, /* skipping request outside macro: ... */
+       MANDOCERR_REQ_INSEC, /* skipping insecure request: request */
+       MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
+       MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
+       MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */
+       MANDOCERR_RE_NOTOPEN, /* fewer RS blocks open, skipping: RE arg */
+       MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */
+       MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */
+
+       /* related to request and macro arguments */
+       MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
+       MANDOCERR_ARG_UNDEF, /* using macro argument outside macro */
+       MANDOCERR_ARG_NONUM, /* argument number is not numeric */
+       MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
+       MANDOCERR_BD_NOARG, /* skipping display without arguments: Bd */
+       MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
+       MANDOCERR_CE_NONUM, /* argument is not numeric, using 1: ce ... */
+       MANDOCERR_CHAR_ARG, /* argument is not a character: char ... */
+       MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
+       MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
+       MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
+       MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
+       MANDOCERR_SHIFT, /* excessive shift: ..., but max is ... */
+       MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
+       MANDOCERR_SO_FAIL, /* .so request failed */
+       MANDOCERR_TG_SPC, /* skipping tag containing whitespace: tag */
+       MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
+       MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
+       MANDOCERR_DIVZERO, /* divide by zero */
+
+       MANDOCERR_UNSUPP, /* ===== start of unsupported features ===== */
+
+       MANDOCERR_TOOLARGE, /* input too large */
+       MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */
+       MANDOCERR_ESC_UNSUPP, /* unsupported escape sequence: escape */
+       MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */
+       MANDOCERR_WHILE_NEST, /* nested .while loops */
+       MANDOCERR_WHILE_OUTOF, /* end of scope with open .while loop */
+       MANDOCERR_WHILE_INTO, /* end of .while loop in inner scope */
+       MANDOCERR_WHILE_FAIL, /* cannot continue this .while loop */
+       MANDOCERR_TBLOPT_EQN, /* eqn delim option in tbl: arg */
+       MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */
+       MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */
+       MANDOCERR_TBL_TMAN, /* skipping tbl in -Tman mode */
+       MANDOCERR_EQN_TMAN, /* skipping eqn in -Tman mode */
+
+       MANDOCERR_BADARG, /* ===== start of bad invocations ===== */
+
+       MANDOCERR_BADARG_BAD, /* bad argument */
+       MANDOCERR_BADARG_DUPE, /* duplicate argument */
+       MANDOCERR_BADVAL, /* does not take a value */
+       MANDOCERR_BADVAL_MISS, /* missing argument value */
+       MANDOCERR_BADVAL_BAD, /* bad argument value */
+       MANDOCERR_BADVAL_DUPE, /* duplicate argument value */
+       MANDOCERR_TAG, /* no such tag */
+       MANDOCERR_MAN_TMARKDOWN, /* -Tmarkdown unsupported for man(7) input */
+
+       MANDOCERR_SYSERR, /* ===== start of system errors ===== */
+
+       MANDOCERR_DUP,
+       MANDOCERR_EXEC,
+       MANDOCERR_FDOPEN,
+       MANDOCERR_FFLUSH,
+       MANDOCERR_FORK,
+       MANDOCERR_FSTAT,
+       MANDOCERR_GETLINE,
+       MANDOCERR_GLOB,
+       MANDOCERR_GZCLOSE,
+       MANDOCERR_GZDOPEN,
+       MANDOCERR_MKSTEMP,
+       MANDOCERR_OPEN,
+       MANDOCERR_PLEDGE,
+       MANDOCERR_READ,
+       MANDOCERR_WAIT,
+       MANDOCERR_WRITE,

 
 

-       MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
-
-       MANDOCERR_NOTMANUAL, /* manual isn't really a manual */
-       MANDOCERR_COLUMNS, /* column syntax is inconsistent */
-       MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
-       MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
-       MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
-       MANDOCERR_SYNTCHILD, /* child violates parent syntax */
-       MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
-       MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
-       MANDOCERR_NODOCBODY, /* no document body */
-       MANDOCERR_NODOCPROLOG, /* no document prologue */
-       MANDOCERR_MEM, /* static buffer exhausted */

        MANDOCERR_MAX
 };
 
        MANDOCERR_MAX
 };
 

-struct tbl {
-       char              tab; /* cell-separator */
-       char              decimal; /* decimal point */
-       int               linesize;
-       int               opts;
-#define        TBL_OPT_CENTRE   (1 << 0)
-#define        TBL_OPT_EXPAND   (1 << 1)
-#define        TBL_OPT_BOX      (1 << 2)
-#define        TBL_OPT_DBOX     (1 << 3)
-#define        TBL_OPT_ALLBOX   (1 << 4)
-#define        TBL_OPT_NOKEEP   (1 << 5)
-#define        TBL_OPT_NOSPACE  (1 << 6)
-       int               cols; /* number of columns */
-};
-
-enum   tbl_headt {
-       TBL_HEAD_DATA, /* plug in data from tbl_dat */
-       TBL_HEAD_VERT, /* vertical spacer */
-       TBL_HEAD_DVERT  /* double-vertical spacer */
-};
-
-/*
- * The head of a table specifies all of its columns.  When formatting a
- * tbl_span, iterate over these and plug in data from the tbl_span when
- * appropriate, using tbl_cell as a guide to placement.
- */
-struct tbl_head {
-       enum tbl_headt    pos;
-       int               ident; /* 0 <= unique id < cols */
-       struct tbl_head  *next;
-       struct tbl_head  *prev;
-};
-
-enum   tbl_cellt {
-       TBL_CELL_CENTRE, /* c, C */
-       TBL_CELL_RIGHT, /* r, R */
-       TBL_CELL_LEFT, /* l, L */
-       TBL_CELL_NUMBER, /* n, N */
-       TBL_CELL_SPAN, /* s, S */
-       TBL_CELL_LONG, /* a, A */
-       TBL_CELL_DOWN, /* ^ */
-       TBL_CELL_HORIZ, /* _, - */
-       TBL_CELL_DHORIZ, /* = */
-       TBL_CELL_VERT, /* | */
-       TBL_CELL_DVERT, /* || */
-       TBL_CELL_MAX
-};
-
-/*
- * A cell in a layout row.
- */
-struct tbl_cell {
-       struct tbl_cell  *next;
-       enum tbl_cellt    pos;
-       size_t            spacing;
-       int               flags;
-#define        TBL_CELL_TALIGN  (1 << 0) /* t, T */
-#define        TBL_CELL_BALIGN  (1 << 1) /* d, D */
-#define        TBL_CELL_BOLD    (1 << 2) /* fB, B, b */
-#define        TBL_CELL_ITALIC  (1 << 3) /* fI, I, i */
-#define        TBL_CELL_EQUAL   (1 << 4) /* e, E */
-#define        TBL_CELL_UP      (1 << 5) /* u, U */
-#define        TBL_CELL_WIGN    (1 << 6) /* z, Z */
-       struct tbl_head  *head;
-};
-
-/*
- * A layout row.
- */
-struct tbl_row {
-       struct tbl_row   *next;
-       struct tbl_cell  *first;
-       struct tbl_cell  *last;
-};
-
-enum   tbl_datt {
-       TBL_DATA_NONE, /* has no data */
-       TBL_DATA_DATA, /* consists of data/string */
-       TBL_DATA_HORIZ, /* horizontal line */
-       TBL_DATA_DHORIZ, /* double-horizontal line */
-       TBL_DATA_NHORIZ, /* squeezed horizontal line */
-       TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
-};
-
-/*
- * A cell within a row of data.  The "string" field contains the actual
- * string value that's in the cell.  The rest is layout.
- */
-struct tbl_dat {
-       struct tbl_cell  *layout; /* layout cell */
-       int               spans; /* how many spans follow */
-       struct tbl_dat   *next;
-       char             *string; /* data (NULL if not TBL_DATA_DATA) */
-       enum tbl_datt     pos;
-};
-
-enum   tbl_spant {
-       TBL_SPAN_DATA, /* span consists of data */
-       TBL_SPAN_HORIZ, /* span is horizontal line */
-       TBL_SPAN_DHORIZ /* span is double horizontal line */
-};
-
-/*
- * A row of data in a table.
- */
-struct tbl_span {
-       struct tbl       *tbl;
-       struct tbl_head  *head;
-       struct tbl_row   *layout; /* layout row */
-       struct tbl_dat   *first;
-       struct tbl_dat   *last;
-       int               line; /* parse line */
-       int               flags;
-#define        TBL_SPAN_FIRST   (1 << 0)
-#define        TBL_SPAN_LAST    (1 << 1)
-       enum tbl_spant    pos;
-       struct tbl_span  *next;
-};
-
-struct eqn {
-       size_t            sz;
-       char             *data;
-       int               line; /* invocation line */
-       int               pos; /* invocation position */
-};
-
-/*
- * The type of parse sequence.  This value is usually passed via the
- * mandoc(1) command line of -man and -mdoc.  It's almost exclusively
- * -mandoc but the others have been retained for compatibility.
- */
-enum   mparset {
-       MPARSE_AUTO, /* magically determine the document type */
-       MPARSE_MDOC, /* assume -mdoc */
-       MPARSE_MAN /* assume -man */
-};
-

 enum   mandoc_esc {
        ESCAPE_ERROR = 0, /* bail! unparsable escape */
 enum   mandoc_esc {
        ESCAPE_ERROR = 0, /* bail! unparsable escape */

+       ESCAPE_UNSUPP, /* unsupported escape; ignore it */

        ESCAPE_IGNORE, /* escape to be ignored */
        ESCAPE_IGNORE, /* escape to be ignored */

+       ESCAPE_UNDEF, /* undefined escape; print literal character */

        ESCAPE_SPECIAL, /* a regular special character */
        ESCAPE_FONT, /* a generic font mode */
        ESCAPE_FONTBOLD, /* bold font mode */
        ESCAPE_FONTITALIC, /* italic font mode */
        ESCAPE_SPECIAL, /* a regular special character */
        ESCAPE_FONT, /* a generic font mode */
        ESCAPE_FONTBOLD, /* bold font mode */
        ESCAPE_FONTITALIC, /* italic font mode */

+       ESCAPE_FONTBI, /* bold italic font mode */

        ESCAPE_FONTROMAN, /* roman font mode */
        ESCAPE_FONTROMAN, /* roman font mode */

+       ESCAPE_FONTCR, /* constant width font mode */
+       ESCAPE_FONTCB, /* constant width bold font mode */
+       ESCAPE_FONTCI, /* constant width italic font mode */

        ESCAPE_FONTPREV, /* previous font mode */
        ESCAPE_NUMBERED, /* a numbered glyph */
        ESCAPE_UNICODE, /* a unicode codepoint */
        ESCAPE_FONTPREV, /* previous font mode */
        ESCAPE_NUMBERED, /* a numbered glyph */
        ESCAPE_UNICODE, /* a unicode codepoint */

-       ESCAPE_NOSPACE /* suppress space if the last on a line */
+       ESCAPE_DEVICE, /* print the output device name */
+       ESCAPE_BREAK, /* break the output line */
+       ESCAPE_NOSPACE, /* suppress space if the last on a line */
+       ESCAPE_HORIZ, /* horizontal movement */
+       ESCAPE_HLINE, /* horizontal line drawing */
+       ESCAPE_SKIPCHAR, /* skip the next character */
+       ESCAPE_OVERSTRIKE /* overstrike all chars in the argument */

 };
 
 };
 

-typedef        void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
-                       const char *, int, int, const char *);
-
-struct mparse;
-struct mchars;
-struct mdoc;
-struct man;
-
-__BEGIN_DECLS
-
-void             mparse_free(struct mparse *);
-void             mparse_reset(struct mparse *);
-struct mparse   *mparse_alloc(enum mparset, 
-                       enum mandoclevel, mandocmsg, void *);
-enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
-void             mparse_result(struct mparse *, struct mdoc **, struct man **);
-const char      *mparse_strerror(enum mandocerr);
-const char      *mparse_strlevel(enum mandoclevel);
-
-void            *mandoc_calloc(size_t, size_t);
-void            *mandoc_malloc(size_t);
-void            *mandoc_realloc(void *, size_t);
-char            *mandoc_strdup(const char *);

 
 

+enum mandoc_esc          mandoc_font(const char *, int);

 enum mandoc_esc          mandoc_escape(const char **, const char **, int *);
 enum mandoc_esc          mandoc_escape(const char **, const char **, int *);

-
-struct mchars   *mchars_alloc(void);
-char             mchars_num2char(const char *, size_t);
+void             mandoc_msg_setoutfile(FILE *);
+const char      *mandoc_msg_getinfilename(void);
+void             mandoc_msg_setinfilename(const char *);
+enum mandocerr   mandoc_msg_getmin(void);
+void             mandoc_msg_setmin(enum mandocerr);
+enum mandoclevel  mandoc_msg_getrc(void);
+void             mandoc_msg_setrc(enum mandoclevel);
+void             mandoc_msg(enum mandocerr, int, int, const char *, ...)
+                       __attribute__((__format__ (__printf__, 4, 5)));
+void             mandoc_msg_summary(void);
+void             mchars_alloc(void);
+void             mchars_free(void);
+int              mchars_num2char(const char *, size_t);
+const char      *mchars_uc2str(int);

 int              mchars_num2uc(const char *, size_t);
 int              mchars_num2uc(const char *, size_t);

-const char      *mchars_spec2str(struct mchars *, const char *, size_t, size_t *);
-int              mchars_spec2cp(struct mchars *, const char *, size_t);
-void             mchars_free(struct mchars *);
-
-
-__END_DECLS
-
-#endif /*!MANDOC_H*/
+int              mchars_spec2cp(const char *, size_t);
+const char      *mchars_spec2str(const char *, size_t, size_t *);