sync Copyright years after merge to OpenBSD; no code change

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index 14687e0bd6c453d3f4eb95765de2e7c980b6445a..6af825a74df67e31b7b8934dcdbc456b74e587db 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,6 +1,7 @@
-/*     $Id: mandoc.h,v 1.33 2010/12/10 20:58:56 schwarze Exp $ */
+/*     $Id: mandoc.h,v 1.160 2014/10/10 15:26:29 schwarze Exp $ */

 /*
 /*

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

  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -19,6 +20,7 @@
 
 #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


@@ -47,138 +49,399 @@ enum      mandocerr {
        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_BADDATE, /* cannot parse date argument */
-       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_TITLE_CASE, /* lower case character in document title */
+       MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
+       MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
+       MANDOCERR_ARCH_BAD, /* unknown manual volume or arch: Dt ... volume */
+       MANDOCERR_DATE_MISSING, /* missing date, using today's date */
+       MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
+       MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
+       MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
+       MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */
+       MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */
+       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_BAD, /* bad NAME section contents: macro */
+       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_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_SCOPENEST, /* blocks badly nested */
-       MANDOCERR_CHILD, /* child violates parent syntax */
-       MANDOCERR_NESTEDDISP, /* nested displays are not portable */
-       MANDOCERR_SCOPEREP, /* already in literal mode */
-
-       /* related to missing macro arguments */
-       MANDOCERR_MACROEMPTY, /* skipping empty macro */
-       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 */
-
-       /* 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_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_VT_CHILD, /* .Vt block has child macro: macro */
+       MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
+       MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
+       MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
+
+       /* 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_ARG_EMPTY, /* empty argument, using 0n: macro arg */
+       MANDOCERR_ARGCWARN, /* argument count wrong */
+       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 8n */
+       MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
+       MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
+       MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */
+       MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */
+       MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */
+       MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
+
+       /* related to bad arguments */
+       MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
+       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_AT_BAD, /* unknown AT&T UNIX version: At version */
+       MANDOCERR_FA_COMMA, /* comma in function argument: arg */
+       MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
+       MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
+       MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */

 
        /* 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_SPACE_EOL, /* whitespace at end of input line */
+       MANDOCERR_COMMENT_BAD, /* bad comment style */
+       MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
+       MANDOCERR_STR_UNDEF, /* undefined string, using "": name */

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

+       /* related to equations */
+       MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/
+       MANDOCERR_EQNSCOPE, /* equation scope open on exit */
+       MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */
+       MANDOCERR_EQNEOF, /* unexpected end of equation */
+       MANDOCERR_EQNSYNT, /* equation syntax error */
+
+       /* 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 */
+
+       /* related to document structure and macros */

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

-       MANDOCERR_BADCHAR, /* skipping bad character */
-       MANDOCERR_NOTEXT, /* skipping text before the first section header */
-       MANDOCERR_MACRO, /* skipping unknown macro */
-       MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
-       MANDOCERR_LINESCOPE, /* line scope broken */
+       MANDOCERR_BADCHAR, /* skipping bad character: number */
+       MANDOCERR_MACRO, /* skipping unknown macro: macro */
+       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_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_ARGCOUNT, /* argument count wrong */
        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_BL_NOTYPE, /* missing list type, using -item: Bl */
+       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_ARG_SKIP, /* skipping all arguments: macro args */
+       MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */

 
        MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
 
 
        MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
 

-       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_TOOLARGE, /* input too large */
+       MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
+       MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
+       MANDOCERR_SO_FAIL, /* .so request failed */
+
+       /* ===== system errors ===== */
+
+       MANDOCERR_SYSDUP, /* cannot dup file descriptor */
+       MANDOCERR_SYSEXEC, /* cannot exec */
+       MANDOCERR_SYSEXIT, /* gunzip failed with code */
+       MANDOCERR_SYSFORK, /* cannot fork */
+       MANDOCERR_SYSOPEN, /* cannot open file */
+       MANDOCERR_SYSPIPE, /* cannot open pipe */
+       MANDOCERR_SYSREAD, /* cannot read file */
+       MANDOCERR_SYSSIG, /* gunzip died from signal */
+       MANDOCERR_SYSSTAT, /* cannot stat file */
+       MANDOCERR_SYSWAIT, /* wait failed */
+

        MANDOCERR_MAX
 };
 
        MANDOCERR_MAX
 };
 

+struct tbl_opts {
+       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 */
+};
+

 /*
 /*

- * Available registers (set in libroff, accessed elsewhere).
+ * 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.

  */
  */

-enum   regs {
-       REG_nS = 0,
-       REG__MAX
+struct tbl_head {
+       int               ident; /* 0 <= unique id < cols */
+       int               vert; /* width of preceding vertical line */
+       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_MAX

 };
 
 /*
 };
 
 /*

- * A register (struct reg) can consist of many types: this consists of
- * normalised types from the original string form.
+ * A cell in a layout row.

  */
  */

-union  regval {
-       unsigned  u; /* unsigned integer */
+struct tbl_cell {
+       struct tbl_cell  *next;
+       int               vert; /* width of preceding vertical line */
+       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 single register entity.  If "set" is zero, the value of the
- * register should be the default one, which is per-register.  It's
- * assumed that callers know which type in "v" corresponds to which
- * register value.
+ * A layout row.

  */
  */

-struct reg {
-       int               set; /* whether set or not */
-       union regval      v; /* parsed data */
+struct tbl_row {
+       struct tbl_row   *next;
+       struct tbl_cell  *first;
+       struct tbl_cell  *last;
+       int               vert; /* trailing vertical line */
+};
+
+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 */

 };
 
 /*
 };
 
 /*

- * The primary interface to setting register values is in libroff,
- * although libmdoc and libman from time to time will manipulate
- * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
+ * 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 regset {
-       struct reg        regs[REG__MAX];
+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;

 };
 
 };
 

-__BEGIN_DECLS
+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_opts  *opts;
+       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;
+};
+
+enum   eqn_boxt {
+       EQN_ROOT, /* root of parse tree */
+       EQN_TEXT, /* text (number, variable, whatever) */
+       EQN_SUBEXPR, /* nested `eqn' subexpression */
+       EQN_LIST, /* list (braces, etc.) */
+       EQN_LISTONE, /* singleton list */
+       EQN_PILE, /* vertical pile */
+       EQN_MATRIX /* pile of piles */
+};
+
+enum   eqn_fontt {
+       EQNFONT_NONE = 0,
+       EQNFONT_ROMAN,
+       EQNFONT_BOLD,
+       EQNFONT_FAT,
+       EQNFONT_ITALIC,
+       EQNFONT__MAX
+};
+
+enum   eqn_post {
+       EQNPOS_NONE = 0,
+       EQNPOS_SUP,
+       EQNPOS_SUBSUP,
+       EQNPOS_SUB,
+       EQNPOS_TO,
+       EQNPOS_FROM,
+       EQNPOS_FROMTO,
+       EQNPOS_OVER,
+       EQNPOS_SQRT,
+       EQNPOS__MAX
+};
+
+enum   eqn_pilet {
+       EQNPILE_NONE = 0,
+       EQNPILE_PILE,
+       EQNPILE_CPILE,
+       EQNPILE_RPILE,
+       EQNPILE_LPILE,
+       EQNPILE_COL,
+       EQNPILE_CCOL,
+       EQNPILE_RCOL,
+       EQNPILE_LCOL,
+       EQNPILE__MAX
+};
+
+ /*
+ * A "box" is a parsed mathematical expression as defined by the eqn.7
+ * grammar.
+ */
+struct eqn_box {
+       int               size; /* font size of expression */
+#define        EQN_DEFSIZE       INT_MIN
+       enum eqn_boxt     type; /* type of node */
+       struct eqn_box   *first; /* first child node */
+       struct eqn_box   *last; /* last child node */
+       struct eqn_box   *next; /* node sibling */
+       struct eqn_box   *prev; /* node sibling */
+       struct eqn_box   *parent; /* node sibling */
+       char             *text; /* text (or NULL) */
+       char             *left; /* fence left-hand */
+       char             *right; /* fence right-hand */
+       char             *top; /* expression over-symbol */
+       char             *bottom; /* expression under-symbol */
+       size_t            args; /* arguments in parent */
+       size_t            expectargs; /* max arguments in parent */
+       enum eqn_post     pos; /* position of next box */
+       enum eqn_fontt    font; /* font of box */
+       enum eqn_pilet    pile; /* equation piling */
+};

 
 /*
 
 /*

- * Callback function for warnings, errors, and fatal errors as they
- * occur in the compilers libroff, libmdoc, and libman.
+ * An equation consists of a tree of expressions starting at a given
+ * line and position.

  */
  */

-typedef        int             (*mandocmsg)(enum mandocerr, void *,
-                               int, int, const char *);
+struct eqn {
+       char             *name; /* identifier (or NULL) */
+       struct eqn_box   *root; /* root mathematical expression */
+       int               ln; /* invocation line */
+       int               pos; /* invocation position */
+};
+
+/*
+ * Parse options.
+ */
+#define        MPARSE_MDOC     1  /* assume -mdoc */
+#define        MPARSE_MAN      2  /* assume -man */
+#define        MPARSE_SO       4  /* honour .so requests */
+#define        MPARSE_QUICK    8  /* abort the parse early */
+
+enum   mandoc_esc {
+       ESCAPE_ERROR = 0, /* bail! unparsable escape */
+       ESCAPE_IGNORE, /* escape to be ignored */
+       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_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_SKIPCHAR /* skip the next character */
+};
+
+typedef        void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
+                       const char *, int, int, const char *);
+
+struct mparse;
+struct mchars;
+struct mdoc;
+struct man;
+
+__BEGIN_DECLS
+
+enum mandoc_esc          mandoc_escape(const char **, const char **, int *);
+struct mchars   *mchars_alloc(void);
+void             mchars_free(struct mchars *);
+char             mchars_num2char(const char *, size_t);
+int              mchars_num2uc(const char *, size_t);
+int              mchars_spec2cp(const struct mchars *,
+                       const char *, size_t);
+const char      *mchars_spec2str(const struct mchars *,
+                       const char *, size_t, size_t *);
+struct mparse   *mparse_alloc(int, enum mandoclevel, mandocmsg,
+                       const char *);
+void             mparse_free(struct mparse *);
+void             mparse_keep(struct mparse *);
+enum mandoclevel  mparse_open(struct mparse *, int *, const char *,
+                       pid_t *);
+enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
+enum mandoclevel  mparse_readmem(struct mparse *, const void *, size_t,
+                       const char *);
+void             mparse_reset(struct mparse *);
+void             mparse_result(struct mparse *,
+                       struct mdoc **, struct man **, char **);
+const char      *mparse_getkeep(const struct mparse *);
+const char      *mparse_strerror(enum mandocerr);
+const char      *mparse_strlevel(enum mandoclevel);
+enum mandoclevel  mparse_wait(struct mparse *, pid_t);

 
 __END_DECLS
 
 
 __END_DECLS