Fix incorrectly swapped labels of left/right arrows; from bentley@.

[mandoc.git] / read.c

diff --git a/read.c b/read.c
index b4718e51f555dcb0804ab471741dbe9506e09568..bed97580f66f0e31959d62a25de603b016d93a00 100644 (file)
--- a/read.c
+++ b/read.c
@@ -1,4 +1,4 @@
-/*     $Id: read.c,v 1.162 2017/03/06 17:26:05 schwarze Exp $ */
+/*     $Id: read.c,v 1.191 2017/07/08 17:52:50 schwarze Exp $ */

 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org>
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org>


@@ -42,7 +42,6 @@
 #include "mdoc.h"
 #include "man.h"
 #include "libmandoc.h"
 #include "mdoc.h"
 #include "man.h"
 #include "libmandoc.h"

-#include "roff_int.h"

 
 #define        REPARSE_LIMIT   1000
 
 
 #define        REPARSE_LIMIT   1000
 


@@ -53,10 +52,10 @@ struct      mparse {
        const char       *file; /* filename of current input file */
        struct buf       *primary; /* buffer currently being parsed */
        struct buf       *secondary; /* preprocessed copy of input */
        const char       *file; /* filename of current input file */
        struct buf       *primary; /* buffer currently being parsed */
        struct buf       *secondary; /* preprocessed copy of input */

-       const char       *defos; /* default operating system */
+       const char       *os_s; /* default operating system */

        mandocmsg         mmsg; /* warning/error message handler */
        enum mandoclevel  file_status; /* status of current parse */
        mandocmsg         mmsg; /* warning/error message handler */
        enum mandoclevel  file_status; /* status of current parse */

-       enum mandoclevel  wlevel; /* ignore messages below this */
+       enum mandocerr    mmin; /* ignore messages below this */

        int               options; /* parser options */
        int               gzip; /* current input file is gzipped */
        int               filenc; /* encoding of the current file */
        int               options; /* parser options */
        int               gzip; /* current input file is gzipped */
        int               filenc; /* encoding of the current file */


@@ -66,7 +65,7 @@ struct        mparse {
 
 static void      choose_parser(struct mparse *);
 static void      resize_buf(struct buf *, size_t);
 
 static void      choose_parser(struct mparse *);
 static void      resize_buf(struct buf *, size_t);

-static void      mparse_buf_r(struct mparse *, struct buf, size_t, int);
+static int       mparse_buf_r(struct mparse *, struct buf, size_t, int);

 static int       read_whole_file(struct mparse *, const char *, int,
                                struct buf *, int *);
 static void      mparse_end(struct mparse *);
 static int       read_whole_file(struct mparse *, const char *, int,
                                struct buf *, int *);
 static void      mparse_end(struct mparse *);


@@ -75,7 +74,7 @@ static        void      mparse_parse_buffer(struct mparse *, struct buf,
 
 static const enum mandocerr    mandoclimits[MANDOCLEVEL_MAX] = {
        MANDOCERR_OK,
 
 static const enum mandocerr    mandoclimits[MANDOCLEVEL_MAX] = {
        MANDOCERR_OK,

-       MANDOCERR_WARNING,
+       MANDOCERR_OK,

        MANDOCERR_WARNING,
        MANDOCERR_ERROR,
        MANDOCERR_UNSUPP,
        MANDOCERR_WARNING,
        MANDOCERR_ERROR,
        MANDOCERR_UNSUPP,


@@ -86,20 +85,46 @@ static      const enum mandocerr    mandoclimits[MANDOCLEVEL_MAX] = {
 static const char * const      mandocerrs[MANDOCERR_MAX] = {
        "ok",
 
 static const char * const      mandocerrs[MANDOCERR_MAX] = {
        "ok",
 

+       "base system convention",
+
+       "Mdocdate found",
+       "Mdocdate missing",
+       "unknown architecture",
+       "operating system explicitly specified",
+       "RCS id missing",
+       "referenced manual not found",
+
+       "generic style suggestion",
+
+       "legacy man(7) date format",
+       "lower case character in document title",
+       "duplicate RCS id",
+       "typo in section name",
+       "unterminated quoted argument",
+       "useless macro",
+       "consider using OS macro",
+       "errnos out of order",
+       "duplicate errno",
+       "trailing delimiter",
+       "no blank before trailing delimiter",
+       "fill mode already enabled, skipping",
+       "fill mode already disabled, skipping",
+       "function name without markup",
+       "whitespace at end of input line",
+       "bad comment style",
+

        "generic warning",
 
        /* related to the prologue */
        "missing manual title, using UNTITLED",
        "missing manual title, using \"\"",
        "generic warning",
 
        /* related to the prologue */
        "missing manual title, using UNTITLED",
        "missing manual title, using \"\"",

-       "lower case character in document title",

        "missing manual section, using \"\"",
        "unknown manual section",
        "missing date, using today's date",
        "cannot parse date, using it verbatim",
        "missing manual section, using \"\"",
        "unknown manual section",
        "missing date, using today's date",
        "cannot parse date, using it verbatim",

+       "date in the future, using it anyway",

        "missing Os macro, using \"\"",
        "missing Os macro, using \"\"",

-       "duplicate prologue macro",

        "late prologue macro",
        "late prologue macro",

-       "skipping late title macro",

        "prologue macros out of order",
 
        /* related to document structure */
        "prologue macros out of order",
 
        /* related to document structure */


@@ -117,6 +142,7 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
        "sections out of conventional order",
        "duplicate section title",
        "unexpected section",
        "sections out of conventional order",
        "duplicate section title",
        "unexpected section",

+       "cross reference to self",

        "unusual Xr order",
        "unusual Xr punctuation",
        "AUTHORS section without An macro",
        "unusual Xr order",
        "unusual Xr punctuation",
        "AUTHORS section without An macro",


@@ -130,9 +156,9 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
        "blocks badly nested",
        "nested displays are not portable",
        "moving content out of list",
        "blocks badly nested",
        "nested displays are not portable",
        "moving content out of list",

-       "fill mode already enabled, skipping",
-       "fill mode already disabled, skipping",
+       "first macro on line",

        "line scope broken",
        "line scope broken",

+       "skipping blank line in line scope",

 
        /* related to missing macro arguments */
        "skipping empty request",
 
        /* related to missing macro arguments */
        "skipping empty request",


@@ -147,6 +173,7 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
        "missing function name, using \"\"",
        "empty head in list item",
        "empty list item",
        "missing function name, using \"\"",
        "empty head in list item",
        "empty list item",

+       "missing argument, using next line",

        "missing font type, using \\fR",
        "unknown font type, using \\fR",
        "nothing follows prefix",
        "missing font type, using \\fR",
        "unknown font type, using \\fR",
        "nothing follows prefix",


@@ -158,7 +185,6 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
        "missing eqn box, using \"\"",
 
        /* related to bad macro arguments */
        "missing eqn box, using \"\"",
 
        /* related to bad macro arguments */

-       "unterminated quoted argument",

        "duplicate argument",
        "skipping duplicate argument",
        "skipping duplicate display type",
        "duplicate argument",
        "skipping duplicate argument",
        "skipping duplicate display type",


@@ -168,6 +194,7 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
        "unknown AT&T UNIX version",
        "comma in function argument",
        "parenthesis in function name",
        "unknown AT&T UNIX version",
        "comma in function argument",
        "parenthesis in function name",

+       "unknown library name",

        "invalid content in Rs block",
        "invalid Boolean argument",
        "unknown font, skipping request",
        "invalid content in Rs block",
        "invalid Boolean argument",
        "unknown font, skipping request",


@@ -176,9 +203,7 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
        /* related to plain text */
        "blank line in fill mode, using .sp",
        "tab in filled text",
        /* related to plain text */
        "blank line in fill mode, using .sp",
        "tab in filled text",

-       "whitespace at end of input line",

        "new sentence, new line",
        "new sentence, new line",

-       "bad comment style",

        "invalid escape sequence",
        "undefined string, using \"\"",
 
        "invalid escape sequence",
        "undefined string, using \"\"",
 


@@ -204,6 +229,8 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
 
        /* related to document structure and macros */
        NULL,
 
        /* related to document structure and macros */
        NULL,

+       "duplicate prologue macro",
+       "skipping late title macro",

        "input stack limit exceeded, infinite loop?",
        "skipping bad character",
        "skipping unknown macro",
        "input stack limit exceeded, infinite loop?",
        "skipping bad character",
        "skipping unknown macro",


@@ -220,6 +247,7 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
        "NOT IMPLEMENTED: Bd -file",
        "skipping display without arguments",
        "missing list type, using -item",
        "NOT IMPLEMENTED: Bd -file",
        "skipping display without arguments",
        "missing list type, using -item",

+       "argument is not numeric, using 1",

        "missing manual name, using \"\"",
        "uname(3) system call failed, using UNKNOWN",
        "unknown standard specifier",
        "missing manual name, using \"\"",
        "uname(3) system call failed, using UNKNOWN",
        "unknown standard specifier",


@@ -241,7 +269,7 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
 
 static const char * const      mandoclevels[MANDOCLEVEL_MAX] = {
        "SUCCESS",
 
 static const char * const      mandoclevels[MANDOCLEVEL_MAX] = {
        "SUCCESS",

-       "RESERVED",
+       "STYLE",

        "WARNING",
        "ERROR",
        "UNSUPP",
        "WARNING",
        "ERROR",
        "UNSUPP",


@@ -293,14 +321,15 @@ choose_parser(struct mparse *curp)
        }
 
        if (format == MPARSE_MDOC) {
        }
 
        if (format == MPARSE_MDOC) {

-               mdoc_hash_init();

                curp->man->macroset = MACROSET_MDOC;
                curp->man->macroset = MACROSET_MDOC;

-               curp->man->first->tok = TOKEN_NONE;
+               if (curp->man->mdocmac == NULL)
+                       curp->man->mdocmac = roffhash_alloc(MDOC_Dd, MDOC_MAX);

        } else {
        } else {

-               man_hash_init();

                curp->man->macroset = MACROSET_MAN;
                curp->man->macroset = MACROSET_MAN;

-               curp->man->first->tok = TOKEN_NONE;
+               if (curp->man->manmac == NULL)
+                       curp->man->manmac = roffhash_alloc(MAN_TH, MAN_MAX);

        }
        }

+       curp->man->first->tok = TOKEN_NONE;

 }
 
 /*
 }
 
 /*


@@ -310,15 +339,13 @@ choose_parser(struct mparse *curp)
  * macros, inline equations, and input line traps)
  * and indirectly (for .so file inclusion).
  */
  * macros, inline equations, and input line traps)
  * and indirectly (for .so file inclusion).
  */

-static void
+static int

 mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
 {
 mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
 {

-       const struct tbl_span   *span;

        struct buf       ln;
        const char      *save_file;
        char            *cp;
        size_t           pos; /* byte number in the ln buffer */
        struct buf       ln;
        const char      *save_file;
        char            *cp;
        size_t           pos; /* byte number in the ln buffer */

-       size_t           j;  /* auxiliary byte number in the blk buffer */

        enum rofferr     rr;
        int              of;
        int              lnn; /* line number in the real file */
        enum rofferr     rr;
        int              of;
        int              lnn; /* line number in the real file */


@@ -400,79 +427,14 @@ mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
                                continue;
                        }
 
                                continue;
                        }
 

-                       /* Trailing backslash = a plain char. */
-
-                       if (blk.buf[i] != '\\' || i + 1 == blk.sz) {
-                               ln.buf[pos++] = blk.buf[i++];
-                               continue;
-                       }
-
-                       /*
-                        * Found escape and at least one other character.
-                        * When it's a newline character, skip it.
-                        * When there is a carriage return in between,
-                        * skip that one as well.
-                        */
-
-                       if ('\r' == blk.buf[i + 1] && i + 2 < blk.sz &&
-                           '\n' == blk.buf[i + 2])
-                               ++i;
-                       if ('\n' == blk.buf[i + 1]) {
-                               i += 2;
-                               ++lnn;
-                               continue;
-                       }
-
-                       if ('"' == blk.buf[i + 1] || '#' == blk.buf[i + 1]) {
-                               j = i;
-                               i += 2;
-                               /* Comment, skip to end of line */
-                               for (; i < blk.sz; ++i) {
-                                       if (blk.buf[i] != '\n')
-                                               continue;
-                                       if (blk.buf[i - 1] == ' ' ||
-                                           blk.buf[i - 1] == '\t')
-                                               mandoc_msg(
-                                                   MANDOCERR_SPACE_EOL,
-                                                   curp, curp->line,
-                                                   pos + i-1 - j, NULL);
-                                       ++i;
-                                       ++lnn;
-                                       break;
-                               }
-
-                               /* Backout trailing whitespaces */
-                               for (; pos > 0; --pos) {
-                                       if (ln.buf[pos - 1] != ' ')
-                                               break;
-                                       if (pos > 2 && ln.buf[pos - 2] == '\\')
-                                               break;
-                               }
-                               break;
-                       }
-
-                       /* Catch escaped bogus characters. */
-
-                       c = (unsigned char) blk.buf[i+1];
-
-                       if ( ! (isascii(c) &&
-                           (isgraph(c) || isblank(c)))) {
-                               mandoc_vmsg(MANDOCERR_CHAR_BAD, curp,
-                                   curp->line, pos, "0x%x", c);
-                               i += 2;
-                               ln.buf[pos++] = '?';
-                               continue;
-                       }
-
-                       /* Some other escape sequence, copy & cont. */
-
-                       ln.buf[pos++] = blk.buf[i++];

                        ln.buf[pos++] = blk.buf[i++];
                }
 
                        ln.buf[pos++] = blk.buf[i++];
                }
 

-               if (pos >= ln.sz)
+               if (pos + 1 >= ln.sz)

                        resize_buf(&ln, 256);
 
                        resize_buf(&ln, 256);
 

+               if (i == blk.sz || blk.buf[i] == '\0')
+                       ln.buf[pos++] = '\n';

                ln.buf[pos] = '\0';
 
                /*
                ln.buf[pos] = '\0';
 
                /*


@@ -511,13 +473,16 @@ rerun:
 
                switch (rr) {
                case ROFF_REPARSE:
 
                switch (rr) {
                case ROFF_REPARSE:

-                       if (REPARSE_LIMIT >= ++curp->reparse_count)
-                               mparse_buf_r(curp, ln, of, 0);
-                       else
+                       if (++curp->reparse_count > REPARSE_LIMIT)

                                mandoc_msg(MANDOCERR_ROFFLOOP, curp,
                                    curp->line, pos, NULL);
                                mandoc_msg(MANDOCERR_ROFFLOOP, curp,
                                    curp->line, pos, NULL);

-                       pos = 0;
-                       continue;
+                       else if (mparse_buf_r(curp, ln, of, 0) == 1 ||
+                           start == 1) {
+                               pos = 0;
+                               continue;
+                       }
+                       free(ln.buf);
+                       return 0;

                case ROFF_APPEND:
                        pos = strlen(ln.buf);
                        continue;
                case ROFF_APPEND:
                        pos = strlen(ln.buf);
                        continue;


@@ -531,7 +496,7 @@ rerun:
                            (i >= blk.sz || blk.buf[i] == '\0')) {
                                curp->sodest = mandoc_strdup(ln.buf + of);
                                free(ln.buf);
                            (i >= blk.sz || blk.buf[i] == '\0')) {
                                curp->sodest = mandoc_strdup(ln.buf + of);
                                free(ln.buf);

-                               return;
+                               return 1;

                        }
                        /*
                         * We remove `so' clauses from our lookaside
                        }
                        /*
                         * We remove `so' clauses from our lookaside


@@ -567,21 +532,7 @@ rerun:
                if (curp->man->macroset == MACROSET_NONE)
                        choose_parser(curp);
 
                if (curp->man->macroset == MACROSET_NONE)
                        choose_parser(curp);
 

-               /*
-                * Lastly, push down into the parsers themselves.
-                * If libroff returns ROFF_TBL, then add it to the
-                * currently open parse.  Since we only get here if
-                * there does exist data (see tbl_data.c), we're
-                * guaranteed that something's been allocated.
-                * Do the same for ROFF_EQN.
-                */
-
-               if (rr == ROFF_TBL)
-                       while ((span = roff_span(curp->roff)) != NULL)
-                               roff_addtbl(curp->man, span);
-               else if (rr == ROFF_EQN)
-                       roff_addeqn(curp->man, roff_eqn(curp->roff));
-               else if ((curp->man->macroset == MACROSET_MDOC ?
+               if ((curp->man->macroset == MACROSET_MDOC ?

                    mdoc_parseln(curp->man, curp->line, ln.buf, of) :
                    man_parseln(curp->man, curp->line, ln.buf, of)) == 2)
                                break;
                    mdoc_parseln(curp->man, curp->line, ln.buf, of) :
                    man_parseln(curp->man, curp->line, ln.buf, of)) == 2)
                                break;


@@ -597,6 +548,7 @@ rerun:
        }
 
        free(ln.buf);
        }
 
        free(ln.buf);

+       return 1;

 }
 
 static int
 }
 
 static int


@@ -798,29 +750,32 @@ mparse_open(struct mparse *curp, const char *file)
 }
 
 struct mparse *
 }
 
 struct mparse *

-mparse_alloc(int options, enum mandoclevel wlevel, mandocmsg mmsg,
-    const char *defos)
+mparse_alloc(int options, enum mandocerr mmin, mandocmsg mmsg,
+    enum mandoc_os os_e, const char *os_s)

 {
        struct mparse   *curp;
 
        curp = mandoc_calloc(1, sizeof(struct mparse));
 
        curp->options = options;
 {
        struct mparse   *curp;
 
        curp = mandoc_calloc(1, sizeof(struct mparse));
 
        curp->options = options;

-       curp->wlevel = wlevel;
+       curp->mmin = mmin;

        curp->mmsg = mmsg;
        curp->mmsg = mmsg;

-       curp->defos = defos;
+       curp->os_s = os_s;

 
        curp->roff = roff_alloc(curp, options);
 
        curp->roff = roff_alloc(curp, options);

-       curp->man = roff_man_alloc( curp->roff, curp, curp->defos,
+       curp->man = roff_man_alloc(curp->roff, curp, curp->os_s,

                curp->options & MPARSE_QUICK ? 1 : 0);
        if (curp->options & MPARSE_MDOC) {
                curp->options & MPARSE_QUICK ? 1 : 0);
        if (curp->options & MPARSE_MDOC) {

-               mdoc_hash_init();

                curp->man->macroset = MACROSET_MDOC;
                curp->man->macroset = MACROSET_MDOC;

+               if (curp->man->mdocmac == NULL)
+                       curp->man->mdocmac = roffhash_alloc(MDOC_Dd, MDOC_MAX);

        } else if (curp->options & MPARSE_MAN) {
        } else if (curp->options & MPARSE_MAN) {

-               man_hash_init();

                curp->man->macroset = MACROSET_MAN;
                curp->man->macroset = MACROSET_MAN;

+               if (curp->man->manmac == NULL)
+                       curp->man->manmac = roffhash_alloc(MAN_TH, MAN_MAX);

        }
        curp->man->first->tok = TOKEN_NONE;
        }
        curp->man->first->tok = TOKEN_NONE;

+       curp->man->meta.os_e = os_e;

        return curp;
 }
 
        return curp;
 }
 


@@ -844,6 +799,8 @@ void
 mparse_free(struct mparse *curp)
 {
 
 mparse_free(struct mparse *curp)
 {
 

+       roffhash_free(curp->man->mdocmac);
+       roffhash_free(curp->man->manmac);

        roff_man_free(curp->man);
        roff_free(curp->roff);
        if (curp->secondary)
        roff_man_free(curp->man);
        roff_free(curp->roff);
        if (curp->secondary)


@@ -894,13 +851,13 @@ mandoc_msg(enum mandocerr er, struct mparse *m,
 {
        enum mandoclevel level;
 
 {
        enum mandoclevel level;
 

+       if (er < m->mmin && er != MANDOCERR_FILE)
+               return;
+

        level = MANDOCLEVEL_UNSUPP;
        while (er < mandoclimits[level])
                level--;
 
        level = MANDOCLEVEL_UNSUPP;
        while (er < mandoclimits[level])
                level--;
 

-       if (level < m->wlevel && er != MANDOCERR_FILE)
-               return;
-

        if (m->mmsg)
                (*m->mmsg)(er, level, m->file, ln, col, msg);
 
        if (m->mmsg)
                (*m->mmsg)(er, level, m->file, ln, col, msg);