When a subsection header contains no letters but only special

[mandoc.git] / mandoc.h

diff --git a/mandoc.h b/mandoc.h
index 83623167f4fba5fd8c64cb608c58e67457116c7b..c392b0f23a16bdae288a49d7b02ddbe41d8a8b09 100644 (file)
--- a/mandoc.h
+++ b/mandoc.h
@@ -1,7 +1,7 @@
-/*     $Id: mandoc.h,v 1.232 2017/06/17 23:07:00 schwarze Exp $ */
+/*     $Id: mandoc.h,v 1.253 2018/08/25 16:53:39 schwarze Exp $ */

 /*
  * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
 /*
  * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>

- * Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010-2018 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


@@ -44,35 +44,48 @@ enum        mandoclevel {
 enum   mandocerr {
        MANDOCERR_OK,
 
 enum   mandocerr {
        MANDOCERR_OK,
 

-       MANDOCERR_STYLE, /* ===== start of style suggestions ===== */
+       MANDOCERR_BASE, /* ===== start of base system conventions ===== */

 
        MANDOCERR_MDOCDATE, /* Mdocdate found: Dd ... */
        MANDOCERR_MDOCDATE_MISSING, /* Mdocdate missing: Dd ... */
 
        MANDOCERR_MDOCDATE, /* Mdocdate found: Dd ... */
        MANDOCERR_MDOCDATE_MISSING, /* Mdocdate missing: Dd ... */

-       MANDOCERR_DATE_LEGACY, /* legacy man(7) date format: Dd ... */
+       MANDOCERR_ARCH_BAD,  /* unknown architecture: Dt ... arch */
+       MANDOCERR_OS_ARG,  /* operating system explicitly specified: Os ... */

        MANDOCERR_RCS_MISSING, /* RCS id missing */
        MANDOCERR_RCS_MISSING, /* RCS id missing */

+       MANDOCERR_XR_BAD,  /* referenced manual not found: Xr name sec */
+
+       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_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_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_ND_DOT, /* description line ends with a full stop */
-       MANDOCERR_DELIM, /* no blank before trailing delimiter: macro ... */
+       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_DASHDASH, /* verbatim "--", maybe consider using \(em */

        MANDOCERR_FUNC, /* function name without markup: name() */
        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_DT_NOTITLE, /* missing manual title, using UNTITLED: line */
        MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */
 
        MANDOCERR_WARNING, /* ===== start of warnings ===== */
 
        /* related to the prologue */
        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_DATE_MISSING, /* missing date, using today's date */
        MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
        MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
        MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
        MANDOCERR_DATE_MISSING, /* missing date, using today's date */
        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_OS_MISSING, /* missing Os macro, using "" */

-       MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */

        MANDOCERR_PROLOG_LATE, /* late 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 */
        MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macros */
 
        /* related to document structure */


@@ -90,6 +103,7 @@ enum mandocerr {
        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_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 */
        MANDOCERR_XR_ORDER, /* unusual Xr order: ... after ... */
        MANDOCERR_XR_PUNCT, /* unusual Xr punctuation: ... after ... */
        MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */


@@ -103,8 +117,7 @@ enum        mandocerr {
        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_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_FI_SKIP, /* fill mode already enabled, skipping: fi */
-       MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
+       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 */
 
        MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
        MANDOCERR_BLK_BLANK, /* skipping blank line in line scope */
 


@@ -121,6 +134,7 @@ enum        mandocerr {
        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_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_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 */


@@ -132,7 +146,6 @@ enum        mandocerr {
        MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
 
        /* related to bad arguments */
        MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
 
        /* 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_ARG_REP, /* duplicate argument: macro arg */
        MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */
        MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */


@@ -145,15 +158,14 @@ enum      mandocerr {
        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_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 */
        MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
        MANDOCERR_FI_TAB, /* tab in filled text */
        MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
        MANDOCERR_TR_ODD, /* odd number of characters in request: tr char */
 
        /* related to plain text */
        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_EOS, /* new sentence, new line */
        MANDOCERR_EOS, /* new sentence, new line */

-       MANDOCERR_COMMENT_BAD, /* bad comment style */

        MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
        MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
 
        MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
        MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
 


@@ -179,9 +191,12 @@ enum       mandocerr {
 
        /* related to document structure and macros */
        MANDOCERR_FILE, /* cannot open file */
 
        /* related to document structure and macros */
        MANDOCERR_FILE, /* cannot open file */

+       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_CHAR_BAD, /* skipping bad character: number */
        MANDOCERR_MACRO, /* skipping unknown macro: macro */
        MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
        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_REQ_INSEC, /* skipping insecure request: request */
        MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
        MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */


@@ -192,14 +207,18 @@ enum      mandocerr {
 
        /* related to request and macro arguments */
        MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
 
        /* 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_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_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_ARG_SKIP, /* skipping all arguments: macro args */
        MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
        MANDOCERR_SO_FAIL, /* .so request failed */
        MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */


@@ -211,6 +230,10 @@ enum       mandocerr {
        MANDOCERR_TOOLARGE, /* input too large */
        MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */
        MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */
        MANDOCERR_TOOLARGE, /* input too large */
        MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */
        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_TBLOPT_EQN, /* eqn delim option in tbl: arg */
        MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */
        MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */


@@ -323,11 +346,9 @@ struct     tbl_span {
 };
 
 enum   eqn_boxt {
 };
 
 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_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 */
 };
        EQN_PILE, /* vertical pile */
        EQN_MATRIX /* pile of piles */
 };


@@ -392,17 +413,6 @@ struct     eqn_box {
        enum eqn_pilet    pile; /* equation piling */
 };
 
        enum eqn_pilet    pile; /* equation piling */
 };
 

-/*
- * An equation consists of a tree of expressions starting at a given
- * line and position.
- */
-struct eqn {
-       char             *name; /* identifier (or NULL) */
-       struct eqn_box   *root; /* root mathematical expression */
-       int               ln; /* invocation line */
-       int               pos; /* invocation position */
-};
-

 /*
  * Parse options.
  */
 /*
  * Parse options.
  */


@@ -413,6 +423,12 @@ struct     eqn {
 #define        MPARSE_UTF8     16 /* accept UTF-8 input */
 #define        MPARSE_LATIN1   32 /* accept ISO-LATIN-1 input */
 
 #define        MPARSE_UTF8     16 /* accept UTF-8 input */
 #define        MPARSE_LATIN1   32 /* accept ISO-LATIN-1 input */
 

+enum   mandoc_os {
+       MANDOC_OS_OTHER = 0,
+       MANDOC_OS_NETBSD,
+       MANDOC_OS_OPENBSD
+};
+

 enum   mandoc_esc {
        ESCAPE_ERROR = 0, /* bail! unparsable escape */
        ESCAPE_IGNORE, /* escape to be ignored */
 enum   mandoc_esc {
        ESCAPE_ERROR = 0, /* bail! unparsable escape */
        ESCAPE_IGNORE, /* escape to be ignored */


@@ -425,6 +441,7 @@ enum        mandoc_esc {
        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_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_BREAK, /* break the output line */
        ESCAPE_NOSPACE, /* suppress space if the last on a line */
        ESCAPE_HORIZ, /* horizontal movement */


@@ -448,9 +465,9 @@ const char   *mchars_uc2str(int);
 int              mchars_num2uc(const char *, size_t);
 int              mchars_spec2cp(const char *, size_t);
 const char      *mchars_spec2str(const char *, size_t, size_t *);
 int              mchars_num2uc(const char *, size_t);
 int              mchars_spec2cp(const char *, size_t);
 const char      *mchars_spec2str(const char *, size_t, size_t *);

-struct mparse   *mparse_alloc(int, enum mandoclevel, mandocmsg, const char *);
+struct mparse   *mparse_alloc(int, enum mandocerr, mandocmsg,
+                       enum mandoc_os, const char *);

 void             mparse_free(struct mparse *);
 void             mparse_free(struct mparse *);

-void             mparse_keep(struct mparse *);

 int              mparse_open(struct mparse *, const char *);
 enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
 enum mandoclevel  mparse_readmem(struct mparse *, void *, size_t,
 int              mparse_open(struct mparse *, const char *);
 enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
 enum mandoclevel  mparse_readmem(struct mparse *, void *, size_t,


@@ -458,7 +475,7 @@ enum mandoclevel  mparse_readmem(struct mparse *, void *, size_t,
 void             mparse_reset(struct mparse *);
 void             mparse_result(struct mparse *,
                        struct roff_man **, char **);
 void             mparse_reset(struct mparse *);
 void             mparse_result(struct mparse *,
                        struct roff_man **, char **);

-const char      *mparse_getkeep(const struct mparse *);
+void             mparse_copy(const struct mparse *);

 const char      *mparse_strerror(enum mandocerr);
 const char      *mparse_strlevel(enum mandoclevel);
 void             mparse_updaterc(struct mparse *, enum mandoclevel *);
 const char      *mparse_strerror(enum mandocerr);
 const char      *mparse_strlevel(enum mandoclevel);
 void             mparse_updaterc(struct mparse *, enum mandoclevel *);