]> git.cameronkatri.com Git - mandoc.git/blobdiff - read.c
fix RCS IDs
[mandoc.git] / read.c
diff --git a/read.c b/read.c
index 67e6a8389768ae3b692b00b1bbaef878536fab71..8d6cb1038bec1ec8735e2ef1601e9d7f6e3de4de 100644 (file)
--- a/read.c
+++ b/read.c
@@ -1,4 +1,4 @@
-/*     $Id: read.c,v 1.93 2014/10/25 01:03:52 schwarze Exp $ */
+/*     $Id: read.c,v 1.104 2014/12/01 04:14:14 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org>
@@ -41,7 +41,6 @@
 #include "libmandoc.h"
 #include "mdoc.h"
 #include "man.h"
-#include "main.h"
 
 #define        REPARSE_LIMIT   1000
 
@@ -51,6 +50,7 @@ struct        mparse {
        struct man       *man; /* man parser */
        struct mdoc      *mdoc; /* mdoc parser */
        struct roff      *roff; /* roff parser (!NULL) */
+       const struct mchars *mchars; /* character table */
        char             *sodest; /* filename pointed to by .so */
        const char       *file; /* filename of current input file */
        struct buf       *primary; /* buffer currently being parsed */
@@ -63,11 +63,12 @@ struct      mparse {
        int               filenc; /* encoding of the current file */
        int               reparse_count; /* finite interp. stack */
        int               line; /* line number in the file */
+       pid_t             child; /* the gunzip(1) process */
 };
 
 static void      choose_parser(struct mparse *);
 static void      resize_buf(struct buf *, size_t);
-static void      mparse_buf_r(struct mparse *, struct buf, int);
+static void      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 *);
@@ -95,7 +96,6 @@ static        const char * const      mandocerrs[MANDOCERR_MAX] = {
        "lower case character in document title",
        "missing manual section, using \"\"",
        "unknown manual section",
-       "unknown manual volume or arch",
        "missing date, using today's date",
        "cannot parse date, using it verbatim",
        "missing Os macro, using \"\"",
@@ -119,6 +119,7 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
 
        /* related to macros and nesting */
        "obsolete macro",
+       "macro neither callable nor escaped",
        "skipping paragraph macro",
        "moving paragraph macro out of list",
        "skipping no-space macro",
@@ -144,6 +145,7 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
        "empty list item",
        "missing font type, using \\fR",
        "unknown font type, using \\fR",
+       "nothing follows prefix",
        "missing -std argument, adding it",
        "missing eqn box, using \"\"",
 
@@ -200,6 +202,7 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
        /* related to request and macro arguments */
        "escaped character not allowed in a name",
        "argument count wrong",
+       "NOT IMPLEMENTED: Bd -file",
        "missing list type, using -item",
        "missing manual name, using \"\"",
        "uname(3) system call failed, using UNKNOWN",
@@ -212,7 +215,6 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
        "generic fatal error",
 
        "input too large",
-       "NOT IMPLEMENTED: Bd -file",
        "NOT IMPLEMENTED: .so with absolute path or \"..\"",
        ".so request failed",
 
@@ -302,27 +304,29 @@ choose_parser(struct mparse *curp)
 }
 
 /*
- * Main parse routine for an opened file.  This is called for each
- * opened file and simply loops around the full input file, possibly
- * nesting (i.e., with `so').
+ * Main parse routine for a buffer.
+ * It assumes encoding and line numbering are already set up.
+ * It can recurse directly (for invocations of user-defined
+ * macros, inline equations, and input line traps)
+ * and indirectly (for .so file inclusion).
  */
 static void
-mparse_buf_r(struct mparse *curp, struct buf blk, int start)
+mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
 {
        const struct tbl_span   *span;
        struct buf       ln;
+       size_t           pos; /* byte number in the ln buffer */
        enum rofferr     rr;
-       int              i, of, rc;
-       int              pos; /* byte number in the ln buffer */
+       int              of;
        int              lnn; /* line number in the real file */
        unsigned char    c;
 
-       memset(&ln, 0, sizeof(struct buf));
+       memset(&ln, 0, sizeof(ln));
 
        lnn = curp->line;
        pos = 0;
 
-       for (i = blk.offs; i < (int)blk.sz; ) {
+       while (i < blk.sz) {
                if (0 == pos && '\0' == blk.buf[i])
                        break;
 
@@ -332,13 +336,11 @@ mparse_buf_r(struct mparse *curp, struct buf blk, int start)
 
                        if (lnn < 3 &&
                            curp->filenc & MPARSE_UTF8 &&
-                           curp->filenc & MPARSE_LATIN1) {
-                               blk.offs = i;
-                               curp->filenc = preconv_cue(&blk);
-                       }
+                           curp->filenc & MPARSE_LATIN1)
+                               curp->filenc = preconv_cue(&blk, i);
                }
 
-               while (i < (int)blk.sz && (start || '\0' != blk.buf[i])) {
+               while (i < blk.sz && (start || blk.buf[i] != '\0')) {
 
                        /*
                         * When finding an unescaped newline character,
@@ -346,7 +348,7 @@ mparse_buf_r(struct mparse *curp, struct buf blk, int start)
                         * Skip a preceding carriage return, if any.
                         */
 
-                       if ('\r' == blk.buf[i] && i + 1 < (int)blk.sz &&
+                       if ('\r' == blk.buf[i] && i + 1 < blk.sz &&
                            '\n' == blk.buf[i + 1])
                                ++i;
                        if ('\n' == blk.buf[i]) {
@@ -360,7 +362,7 @@ mparse_buf_r(struct mparse *curp, struct buf blk, int start)
                         * case of 11 bytes: "\\[u10ffff]\0"
                         */
 
-                       if (pos + 11 > (int)ln.sz)
+                       if (pos + 11 > ln.sz)
                                resize_buf(&ln, 256);
 
                        /*
@@ -369,13 +371,8 @@ mparse_buf_r(struct mparse *curp, struct buf blk, int start)
 
                        c = blk.buf[i];
                        if (c & 0x80) {
-                               blk.offs = i;
-                               ln.offs = pos;
-                               if (curp->filenc && preconv_encode(
-                                   &blk, &ln, &curp->filenc)) {
-                                       pos = ln.offs;
-                                       i = blk.offs;
-                               } else {
+                               if ( ! (curp->filenc && preconv_encode(
+                                   &blk, &i, &ln, &pos, &curp->filenc))) {
                                        mandoc_vmsg(MANDOCERR_BADCHAR,
                                            curp, curp->line, pos,
                                            "0x%x", c);
@@ -399,7 +396,7 @@ mparse_buf_r(struct mparse *curp, struct buf blk, int start)
 
                        /* Trailing backslash = a plain char. */
 
-                       if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {
+                       if (blk.buf[i] != '\\' || i + 1 == blk.sz) {
                                ln.buf[pos++] = blk.buf[i++];
                                continue;
                        }
@@ -411,7 +408,7 @@ mparse_buf_r(struct mparse *curp, struct buf blk, int start)
                         * skip that one as well.
                         */
 
-                       if ('\r' == blk.buf[i + 1] && i + 2 < (int)blk.sz &&
+                       if ('\r' == blk.buf[i + 1] && i + 2 < blk.sz &&
                            '\n' == blk.buf[i + 2])
                                ++i;
                        if ('\n' == blk.buf[i + 1]) {
@@ -423,7 +420,7 @@ mparse_buf_r(struct mparse *curp, struct buf blk, int start)
                        if ('"' == blk.buf[i + 1] || '#' == blk.buf[i + 1]) {
                                i += 2;
                                /* Comment, skip to end of line */
-                               for (; i < (int)blk.sz; ++i) {
+                               for (; i < blk.sz; ++i) {
                                        if ('\n' == blk.buf[i]) {
                                                ++i;
                                                ++lnn;
@@ -460,7 +457,7 @@ mparse_buf_r(struct mparse *curp, struct buf blk, int start)
                        ln.buf[pos++] = blk.buf[i++];
                }
 
-               if (pos >= (int)ln.sz)
+               if (pos >= ln.sz)
                        resize_buf(&ln, 256);
 
                ln.buf[pos] = '\0';
@@ -497,20 +494,19 @@ mparse_buf_r(struct mparse *curp, struct buf blk, int start)
                                [curp->secondary->sz] = '\0';
                }
 rerun:
-               rr = roff_parseln(curp->roff, curp->line,
-                   &ln.buf, &ln.sz, of, &of);
+               rr = roff_parseln(curp->roff, curp->line, &ln, &of);
 
                switch (rr) {
                case ROFF_REPARSE:
                        if (REPARSE_LIMIT >= ++curp->reparse_count)
-                               mparse_buf_r(curp, ln, 0);
+                               mparse_buf_r(curp, ln, of, 0);
                        else
                                mandoc_msg(MANDOCERR_ROFFLOOP, curp,
                                    curp->line, pos, NULL);
                        pos = 0;
                        continue;
                case ROFF_APPEND:
-                       pos = (int)strlen(ln.buf);
+                       pos = strlen(ln.buf);
                        continue;
                case ROFF_RERUN:
                        goto rerun;
@@ -521,8 +517,8 @@ rerun:
                        assert(MANDOCLEVEL_FATAL <= curp->file_status);
                        break;
                case ROFF_SO:
-                       if (0 == (MPARSE_SO & curp->options) &&
-                           (i >= (int)blk.sz || '\0' == blk.buf[i])) {
+                       if ( ! (curp->options & MPARSE_SO) &&
+                           (i >= blk.sz || blk.buf[i] == '\0')) {
                                curp->sodest = mandoc_strdup(ln.buf + of);
                                free(ln.buf);
                                return;
@@ -574,34 +570,21 @@ rerun:
                 * Do the same for ROFF_EQN.
                 */
 
-               rc = -1;
-
-               if (ROFF_TBL == rr)
-                       while (NULL != (span = roff_span(curp->roff))) {
-                               rc = curp->man ?
-                                   man_addspan(curp->man, span) :
-                                   mdoc_addspan(curp->mdoc, span);
-                               if (0 == rc)
-                                       break;
-                       }
-               else if (ROFF_EQN == rr)
-                       rc = curp->mdoc ?
-                           mdoc_addeqn(curp->mdoc,
-                               roff_eqn(curp->roff)) :
-                           man_addeqn(curp->man,
-                               roff_eqn(curp->roff));
-               else if (curp->man || curp->mdoc)
-                       rc = curp->man ?
-                           man_parseln(curp->man,
-                               curp->line, ln.buf, of) :
-                           mdoc_parseln(curp->mdoc,
-                               curp->line, ln.buf, of);
-
-               if (0 == rc) {
-                       assert(MANDOCLEVEL_FATAL <= curp->file_status);
-                       break;
-               } else if (2 == rc)
-                       break;
+               if (rr == ROFF_TBL) {
+                       while ((span = roff_span(curp->roff)) != NULL)
+                               if (curp->man == NULL)
+                                       mdoc_addspan(curp->mdoc, span);
+                               else
+                                       man_addspan(curp->man, span);
+               } else if (rr == ROFF_EQN) {
+                       if (curp->man == NULL)
+                               mdoc_addeqn(curp->mdoc, roff_eqn(curp->roff));
+                       else
+                               man_addeqn(curp->man, roff_eqn(curp->roff));
+               } else if ((curp->man == NULL ?
+                   mdoc_parseln(curp->mdoc, curp->line, ln.buf, of) :
+                   man_parseln(curp->man, curp->line, ln.buf, of)) == 2)
+                               break;
 
                /* Temporary buffers typically are not full. */
 
@@ -649,7 +632,6 @@ read_whole_file(struct mparse *curp, const char *file, int fd,
                        return(0);
                }
                *with_mmap = 1;
-               fb->offs = 0;
                fb->sz = (size_t)st.st_size;
                fb->buf = mmap(NULL, fb->sz, PROT_READ, MAP_SHARED, fd, 0);
                if (fb->buf != MAP_FAILED)
@@ -681,7 +663,6 @@ read_whole_file(struct mparse *curp, const char *file, int fd,
                ssz = read(fd, fb->buf + (int)off, fb->sz - off);
                if (ssz == 0) {
                        fb->sz = off;
-                       fb->offs = 0;
                        return(1);
                }
                if (ssz == -1) {
@@ -738,6 +719,7 @@ mparse_parse_buffer(struct mparse *curp, struct buf blk, const char *file)
 {
        struct buf      *svprimary;
        const char      *svfile;
+       size_t           offset;
        static int       recursion_depth;
 
        if (64 < recursion_depth) {
@@ -758,11 +740,12 @@ mparse_parse_buffer(struct mparse *curp, struct buf blk, const char *file)
            (unsigned char)blk.buf[0] == 0xef &&
            (unsigned char)blk.buf[1] == 0xbb &&
            (unsigned char)blk.buf[2] == 0xbf) {
-               blk.offs = 3;
+               offset = 3;
                curp->filenc &= ~MPARSE_LATIN1;
-       }
+       } else
+               offset = 0;
 
-       mparse_buf_r(curp, blk, 1);
+       mparse_buf_r(curp, blk, offset, 1);
 
        if (0 == --recursion_depth && MANDOCLEVEL_FATAL > curp->file_status)
                mparse_end(curp);
@@ -772,41 +755,37 @@ mparse_parse_buffer(struct mparse *curp, struct buf blk, const char *file)
 }
 
 enum mandoclevel
-mparse_readmem(struct mparse *curp, const void *buf, size_t len,
+mparse_readmem(struct mparse *curp, void *buf, size_t len,
                const char *file)
 {
        struct buf blk;
 
-       blk.buf = UNCONST(buf);
+       blk.buf = buf;
        blk.sz = len;
-       blk.offs = 0;
 
        mparse_parse_buffer(curp, blk, file);
        return(curp->file_status);
 }
 
+/*
+ * If a file descriptor is given, use it and assume it points
+ * to the named file.  Otherwise, open the named file.
+ * Read the whole file into memory and call the parsers.
+ * Called recursively when an .so request is encountered.
+ */
 enum mandoclevel
 mparse_readfd(struct mparse *curp, int fd, const char *file)
 {
        struct buf       blk;
        int              with_mmap;
        int              save_filenc;
+       pid_t            save_child;
 
-       if (-1 == fd && -1 == (fd = open(file, O_RDONLY, 0))) {
-               curp->file_status = MANDOCLEVEL_SYSERR;
-               if (curp->mmsg)
-                       (*curp->mmsg)(MANDOCERR_SYSOPEN,
-                           curp->file_status,
-                           file, 0, 0, strerror(errno));
-               return(curp->file_status);
-       }
-
-       /*
-        * Run for each opened file; may be called more than once for
-        * each full parse sequence if the opened file is nested (i.e.,
-        * from `so').  Simply sucks in the whole file and moves into
-        * the parse phase for the file.
-        */
+       save_child = curp->child;
+       if (fd != -1)
+               curp->child = 0;
+       else if (mparse_open(curp, &fd, file) >= MANDOCLEVEL_SYSERR)
+               goto out;
 
        if (read_whole_file(curp, file, fd, &blk, &with_mmap)) {
                save_filenc = curp->filenc;
@@ -822,38 +801,59 @@ mparse_readfd(struct mparse *curp, int fd, const char *file)
                        free(blk.buf);
        }
 
-       if (STDIN_FILENO != fd && -1 == close(fd))
+       if (fd != STDIN_FILENO && close(fd) == -1)
                perror(file);
 
+       mparse_wait(curp);
+out:
+       curp->child = save_child;
        return(curp->file_status);
 }
 
 enum mandoclevel
-mparse_open(struct mparse *curp, int *fd, const char *file,
-       pid_t *child_pid)
+mparse_open(struct mparse *curp, int *fd, const char *file)
 {
        int               pfd[2];
+       int               save_errno;
        char             *cp;
        enum mandocerr    err;
 
        pfd[1] = -1;
        curp->file = file;
+
+       /* Unless zipped, try to just open the file. */
+
        if ((cp = strrchr(file, '.')) == NULL ||
            strcmp(cp + 1, "gz")) {
-               *child_pid = 0;
-               if ((*fd = open(file, O_RDONLY)) == -1) {
-                       err = MANDOCERR_SYSOPEN;
-                       goto out;
-               }
-               return(MANDOCLEVEL_OK);
+               curp->child = 0;
+               if ((*fd = open(file, O_RDONLY)) != -1)
+                       return(MANDOCLEVEL_OK);
+
+               /* Open failed; try to append ".gz". */
+
+               mandoc_asprintf(&cp, "%s.gz", file);
+               file = cp;
+       } else
+               cp = NULL;
+
+       /* Before forking, make sure the file can be read. */
+
+       save_errno = errno;
+       if (access(file, R_OK) == -1) {
+               if (cp != NULL)
+                       errno = save_errno;
+               err = MANDOCERR_SYSOPEN;
+               goto out;
        }
 
+       /* Run gunzip(1). */
+
        if (pipe(pfd) == -1) {
                err = MANDOCERR_SYSPIPE;
                goto out;
        }
 
-       switch (*child_pid = fork()) {
+       switch (curp->child = fork()) {
        case -1:
                err = MANDOCERR_SYSFORK;
                close(pfd[0]);
@@ -876,11 +876,12 @@ mparse_open(struct mparse *curp, int *fd, const char *file,
        }
 
 out:
+       free(cp);
        *fd = -1;
-       *child_pid = 0;
+       curp->child = 0;
        curp->file_status = MANDOCLEVEL_SYSERR;
        if (curp->mmsg)
-               (*curp->mmsg)(err, curp->file_status, file,
+               (*curp->mmsg)(err, curp->file_status, curp->file,
                    0, 0, strerror(errno));
        if (pfd[1] != -1)
                exit(1);
@@ -888,11 +889,14 @@ out:
 }
 
 enum mandoclevel
-mparse_wait(struct mparse *curp, pid_t child_pid)
+mparse_wait(struct mparse *curp)
 {
        int       status;
 
-       if (waitpid(child_pid, &status, 0) == -1) {
+       if (curp->child == 0)
+               return(MANDOCLEVEL_OK);
+
+       if (waitpid(curp->child, &status, 0) == -1) {
                mandoc_msg(MANDOCERR_SYSWAIT, curp, 0, 0,
                    strerror(errno));
                curp->file_status = MANDOCLEVEL_SYSERR;
@@ -914,8 +918,8 @@ mparse_wait(struct mparse *curp, pid_t child_pid)
 }
 
 struct mparse *
-mparse_alloc(int options, enum mandoclevel wlevel,
-               mandocmsg mmsg, const char *defos)
+mparse_alloc(int options, enum mandoclevel wlevel, mandocmsg mmsg,
+    const struct mchars *mchars, const char *defos)
 {
        struct mparse   *curp;
 
@@ -928,7 +932,8 @@ mparse_alloc(int options, enum mandoclevel wlevel,
        curp->mmsg = mmsg;
        curp->defos = defos;
 
-       curp->roff = roff_alloc(curp, options);
+       curp->mchars = mchars;
+       curp->roff = roff_alloc(curp, curp->mchars, options);
        if (curp->options & MPARSE_MDOC)
                curp->pmdoc = mdoc_alloc(
                    curp->roff, curp, curp->defos,