Provide a cleanup function for the term_tab module, freeing memory

[mandoc.git] / read.c

diff --git a/read.c b/read.c
index 17200e0932736b734923f9d89d7a17bf9140a39d..5b33edbe9cef4ef528ba141832e61b490edf52a3 100644 (file)
--- a/read.c
+++ b/read.c
@@ -1,7 +1,7 @@
-/*     $Id: read.c,v 1.208 2018/12/20 21:30:32 schwarze Exp $ */
+/* $Id: read.c,v 1.220 2021/06/27 17:57:54 schwarze Exp $ */

 /*
 /*

+ * Copyright (c) 2010-2020 Ingo Schwarze <schwarze@openbsd.org>

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

- * Copyright (c) 2010-2018 Ingo Schwarze <schwarze@openbsd.org>

  * Copyright (c) 2010, 2012 Joerg Sonnenberger <joerg@netbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * Copyright (c) 2010, 2012 Joerg Sonnenberger <joerg@netbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any


@@ -15,6 +15,12 @@
  * 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.
  * 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.

+ *
+ * Top-level functions of the mandoc(3) parser:
+ * Parser and input encoding selection, decompression,
+ * handling of input bytes, characters, lines, and files,
+ * handling of roff(7) loops and file inclusion,
+ * and steering of the various parsers.

  */
 #include "config.h"
 
  */
 #include "config.h"
 


@@ -41,13 +47,13 @@
 #include "mandoc_parse.h"
 #include "libmandoc.h"
 #include "roff_int.h"
 #include "mandoc_parse.h"
 #include "libmandoc.h"
 #include "roff_int.h"

+#include "tag.h"

 
 #define        REPARSE_LIMIT   1000
 
 struct mparse {
        struct roff      *roff; /* roff parser (!NULL) */
        struct roff_man  *man; /* man parser */
 
 #define        REPARSE_LIMIT   1000
 
 struct mparse {
        struct roff      *roff; /* roff parser (!NULL) */
        struct roff_man  *man; /* man parser */

-       char             *sodest; /* filename pointed to by .so */

        struct buf       *primary; /* buffer currently being parsed */
        struct buf       *secondary; /* copy of top level input */
        struct buf       *loop; /* open .while request line */
        struct buf       *primary; /* buffer currently being parsed */
        struct buf       *secondary; /* copy of top level input */
        struct buf       *loop; /* open .while request line */


@@ -123,15 +129,15 @@ choose_parser(struct mparse *curp)
        }
 
        if (format == MPARSE_MDOC) {
        }
 
        if (format == MPARSE_MDOC) {

-               curp->man->macroset = MACROSET_MDOC;
+               curp->man->meta.macroset = MACROSET_MDOC;

                if (curp->man->mdocmac == NULL)
                        curp->man->mdocmac = roffhash_alloc(MDOC_Dd, MDOC_MAX);
        } else {
                if (curp->man->mdocmac == NULL)
                        curp->man->mdocmac = roffhash_alloc(MDOC_Dd, MDOC_MAX);
        } else {

-               curp->man->macroset = MACROSET_MAN;
+               curp->man->meta.macroset = MACROSET_MAN;

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

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

 }
 
 /*
 }
 
 /*


@@ -148,6 +154,7 @@ mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
        struct buf      *firstln, *lastln, *thisln, *loop;
        char            *cp;
        size_t           pos; /* byte number in the ln buffer */
        struct buf      *firstln, *lastln, *thisln, *loop;
        char            *cp;
        size_t           pos; /* byte number in the ln buffer */

+       size_t           spos; /* at the start of the current line parse */

        int              line_result, result;
        int              of;
        int              lnn; /* line number in the real file */
        int              line_result, result;
        int              of;
        int              lnn; /* line number in the real file */


@@ -158,7 +165,7 @@ mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
        ln.sz = 256;
        ln.buf = mandoc_malloc(ln.sz);
        ln.next = NULL;
        ln.sz = 256;
        ln.buf = mandoc_malloc(ln.sz);
        ln.next = NULL;

-       firstln = loop = NULL;
+       firstln = lastln = loop = NULL;

        lnn = curp->line;
        pos = 0;
        inloop = 0;
        lnn = curp->line;
        pos = 0;
        inloop = 0;


@@ -174,6 +181,7 @@ mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
                            curp->filenc & MPARSE_LATIN1)
                                curp->filenc = preconv_cue(&blk, i);
                }
                            curp->filenc & MPARSE_LATIN1)
                                curp->filenc = preconv_cue(&blk, i);
                }

+               spos = pos;

 
                while (i < blk.sz && (start || blk.buf[i] != '\0')) {
 
 
                while (i < blk.sz && (start || blk.buf[i] != '\0')) {
 


@@ -256,6 +264,8 @@ mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
                /* XXX Ugly hack to mark the end of the input. */
 
                if (i == blk.sz || blk.buf[i] == '\0') {
                /* XXX Ugly hack to mark the end of the input. */
 
                if (i == blk.sz || blk.buf[i] == '\0') {

+                       if (pos + 2 > ln.sz)
+                               resize_buf(&ln, 256);

                        ln.buf[pos++] = '\n';
                        ln.buf[pos] = '\0';
                }
                        ln.buf[pos++] = '\n';
                        ln.buf[pos] = '\0';
                }


@@ -271,7 +281,8 @@ mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
 
                of = 0;
 rerun:
 
                of = 0;
 rerun:

-               line_result = roff_parseln(curp->roff, curp->line, &ln, &of);
+               line_result = roff_parseln(curp->roff, curp->line,
+                   &ln, &of, start && spos == 0 ? pos : 0);

 
                /* Process options. */
 
 
                /* Process options. */
 


@@ -334,9 +345,9 @@ rerun:
                case ROFF_IGN:
                        break;
                case ROFF_CONT:
                case ROFF_IGN:
                        break;
                case ROFF_CONT:

-                       if (curp->man->macroset == MACROSET_NONE)
+                       if (curp->man->meta.macroset == MACROSET_NONE)

                                choose_parser(curp);
                                choose_parser(curp);

-                       if ((curp->man->macroset == MACROSET_MDOC ?
+                       if ((curp->man->meta.macroset == MACROSET_MDOC ?

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


@@ -365,7 +376,8 @@ rerun:
                case ROFF_SO:
                        if ( ! (curp->options & MPARSE_SO) &&
                            (i >= blk.sz || blk.buf[i] == '\0')) {
                case ROFF_SO:
                        if ( ! (curp->options & MPARSE_SO) &&
                            (i >= blk.sz || blk.buf[i] == '\0')) {

-                               curp->sodest = mandoc_strdup(ln.buf + of);
+                               curp->man->meta.sodest =
+                                   mandoc_strdup(ln.buf + of);

                                goto out;
                        }
                        if ((fd = mparse_open(curp, ln.buf + of)) != -1) {
                                goto out;
                        }
                        if ((fd = mparse_open(curp, ln.buf + of)) != -1) {


@@ -429,9 +441,8 @@ read_whole_file(struct mparse *curp, int fd, struct buf *fb, int *with_mmap)
        int              gzerrnum, retval;
 
        if (fstat(fd, &st) == -1) {
        int              gzerrnum, retval;
 
        if (fstat(fd, &st) == -1) {

-               mandoc_msg(MANDOCERR_FILE, 0, 0,
-                   "fstat: %s", strerror(errno));
-               return 0;
+               mandoc_msg(MANDOCERR_FSTAT, 0, 0, "%s", strerror(errno));
+               return -1;

        }
 
        /*
        }
 
        /*


@@ -444,13 +455,13 @@ read_whole_file(struct mparse *curp, int fd, struct buf *fb, int *with_mmap)
        if (curp->gzip == 0 && S_ISREG(st.st_mode)) {
                if (st.st_size > 0x7fffffff) {
                        mandoc_msg(MANDOCERR_TOOLARGE, 0, 0, NULL);
        if (curp->gzip == 0 && S_ISREG(st.st_mode)) {
                if (st.st_size > 0x7fffffff) {
                        mandoc_msg(MANDOCERR_TOOLARGE, 0, 0, NULL);

-                       return 0;
+                       return -1;

                }
                *with_mmap = 1;
                fb->sz = (size_t)st.st_size;
                fb->buf = mmap(NULL, fb->sz, PROT_READ, MAP_SHARED, fd, 0);
                if (fb->buf != MAP_FAILED)
                }
                *with_mmap = 1;
                fb->sz = (size_t)st.st_size;
                fb->buf = mmap(NULL, fb->sz, PROT_READ, MAP_SHARED, fd, 0);
                if (fb->buf != MAP_FAILED)

-                       return 1;
+                       return 0;

        }
 
        if (curp->gzip) {
        }
 
        if (curp->gzip) {


@@ -462,15 +473,15 @@ read_whole_file(struct mparse *curp, int fd, struct buf *fb, int *with_mmap)
                 * which this function must not do.
                 */
                if ((fd = dup(fd)) == -1) {
                 * which this function must not do.
                 */
                if ((fd = dup(fd)) == -1) {

-                       mandoc_msg(MANDOCERR_FILE, 0, 0,
-                           "dup: %s", strerror(errno));
-                       return 0;
+                       mandoc_msg(MANDOCERR_DUP, 0, 0,
+                           "%s", strerror(errno));
+                       return -1;

                }
                if ((gz = gzdopen(fd, "rb")) == NULL) {
                }
                if ((gz = gzdopen(fd, "rb")) == NULL) {

-                       mandoc_msg(MANDOCERR_FILE, 0, 0,
-                           "gzdopen: %s", strerror(errno));
+                       mandoc_msg(MANDOCERR_GZDOPEN, 0, 0,
+                           "%s", strerror(errno));

                        close(fd);
                        close(fd);

-                       return 0;
+                       return -1;

                }
        } else
                gz = NULL;
                }
        } else
                gz = NULL;


@@ -482,7 +493,7 @@ read_whole_file(struct mparse *curp, int fd, struct buf *fb, int *with_mmap)
 
        *with_mmap = 0;
        off = 0;
 
        *with_mmap = 0;
        off = 0;

-       retval = 0;
+       retval = -1;

        fb->sz = 0;
        fb->buf = NULL;
        for (;;) {
        fb->sz = 0;
        fb->buf = NULL;
        for (;;) {


@@ -498,13 +509,13 @@ read_whole_file(struct mparse *curp, int fd, struct buf *fb, int *with_mmap)
                    read(fd, fb->buf + (int)off, fb->sz - off);
                if (ssz == 0) {
                        fb->sz = off;
                    read(fd, fb->buf + (int)off, fb->sz - off);
                if (ssz == 0) {
                        fb->sz = off;

-                       retval = 1;
+                       retval = 0;

                        break;
                }
                if (ssz == -1) {
                        if (curp->gzip)
                                (void)gzerror(gz, &gzerrnum);
                        break;
                }
                if (ssz == -1) {
                        if (curp->gzip)
                                (void)gzerror(gz, &gzerrnum);

-                       mandoc_msg(MANDOCERR_FILE, 0, 0, "read: %s",
+                       mandoc_msg(MANDOCERR_READ, 0, 0, "%s",

                            curp->gzip && gzerrnum != Z_ERRNO ?
                            zError(gzerrnum) : strerror(errno));
                        break;
                            curp->gzip && gzerrnum != Z_ERRNO ?
                            zError(gzerrnum) : strerror(errno));
                        break;


@@ -513,10 +524,10 @@ read_whole_file(struct mparse *curp, int fd, struct buf *fb, int *with_mmap)
        }
 
        if (curp->gzip && (gzerrnum = gzclose(gz)) != Z_OK)
        }
 
        if (curp->gzip && (gzerrnum = gzclose(gz)) != Z_OK)

-               mandoc_msg(MANDOCERR_FILE, 0, 0, "gzclose: %s",
+               mandoc_msg(MANDOCERR_GZCLOSE, 0, 0, "%s",

                    gzerrnum == Z_ERRNO ? strerror(errno) :
                    zError(gzerrnum));
                    gzerrnum == Z_ERRNO ? strerror(errno) :
                    zError(gzerrnum));

-       if (retval == 0) {
+       if (retval == -1) {

                free(fb->buf);
                fb->buf = NULL;
        }
                free(fb->buf);
                fb->buf = NULL;
        }


@@ -526,9 +537,9 @@ read_whole_file(struct mparse *curp, int fd, struct buf *fb, int *with_mmap)
 static void
 mparse_end(struct mparse *curp)
 {
 static void
 mparse_end(struct mparse *curp)
 {

-       if (curp->man->macroset == MACROSET_NONE)
-               curp->man->macroset = MACROSET_MAN;
-       if (curp->man->macroset == MACROSET_MDOC)
+       if (curp->man->meta.macroset == MACROSET_NONE)
+               curp->man->meta.macroset = MACROSET_MAN;
+       if (curp->man->meta.macroset == MACROSET_MDOC)

                mdoc_endparse(curp->man);
        else
                man_endparse(curp->man);
                mdoc_endparse(curp->man);
        else
                man_endparse(curp->man);


@@ -546,7 +557,7 @@ mparse_readfd(struct mparse *curp, int fd, const char *filename)
 
        struct buf       blk;
        struct buf      *save_primary;
 
        struct buf       blk;
        struct buf      *save_primary;

-       const char      *save_filename;
+       const char      *save_filename, *cp;

        size_t           offset;
        int              save_filenc, save_lineno;
        int              with_mmap;
        size_t           offset;
        int              save_filenc, save_lineno;
        int              with_mmap;


@@ -554,8 +565,14 @@ mparse_readfd(struct mparse *curp, int fd, const char *filename)
        if (recursion_depth > 64) {
                mandoc_msg(MANDOCERR_ROFFLOOP, curp->line, 0, NULL);
                return;
        if (recursion_depth > 64) {
                mandoc_msg(MANDOCERR_ROFFLOOP, curp->line, 0, NULL);
                return;

-       }
-       if (read_whole_file(curp, fd, &blk, &with_mmap) == 0)
+       } else if (recursion_depth == 0 &&
+           (cp = strrchr(filename, '.')) != NULL &&
+            cp[1] >= '1' && cp[1] <= '9')
+                curp->man->filesec = cp[1];
+        else
+                curp->man->filesec = '\0';
+
+       if (read_whole_file(curp, fd, &blk, &with_mmap) == -1)

                return;
 
        /*
                return;
 
        /*


@@ -607,7 +624,7 @@ int
 mparse_open(struct mparse *curp, const char *file)
 {
        char             *cp;
 mparse_open(struct mparse *curp, const char *file)
 {
        char             *cp;

-       int               fd;
+       int               fd, save_errno;

 
        cp = strrchr(file, '.');
        curp->gzip = (cp != NULL && ! strcmp(cp + 1, "gz"));
 
        cp = strrchr(file, '.');
        curp->gzip = (cp != NULL && ! strcmp(cp + 1, "gz"));


@@ -623,9 +640,11 @@ mparse_open(struct mparse *curp, const char *file)
         */
 
        if ( ! curp->gzip) {
         */
 
        if ( ! curp->gzip) {

+               save_errno = errno;

                mandoc_asprintf(&cp, "%s.gz", file);
                fd = open(cp, O_RDONLY);
                free(cp);
                mandoc_asprintf(&cp, "%s.gz", file);
                fd = open(cp, O_RDONLY);
                free(cp);

+               errno = save_errno;

                if (fd != -1) {
                        curp->gzip = 1;
                        return fd;
                if (fd != -1) {
                        curp->gzip = 1;
                        return fd;


@@ -651,54 +670,56 @@ mparse_alloc(int options, enum mandoc_os os_e, const char *os_s)
        curp->man = roff_man_alloc(curp->roff, curp->os_s,
                curp->options & MPARSE_QUICK ? 1 : 0);
        if (curp->options & MPARSE_MDOC) {
        curp->man = roff_man_alloc(curp->roff, curp->os_s,
                curp->options & MPARSE_QUICK ? 1 : 0);
        if (curp->options & MPARSE_MDOC) {

-               curp->man->macroset = MACROSET_MDOC;
+               curp->man->meta.macroset = MACROSET_MDOC;

                if (curp->man->mdocmac == NULL)
                        curp->man->mdocmac = roffhash_alloc(MDOC_Dd, MDOC_MAX);
        } else if (curp->options & MPARSE_MAN) {
                if (curp->man->mdocmac == NULL)
                        curp->man->mdocmac = roffhash_alloc(MDOC_Dd, MDOC_MAX);
        } else if (curp->options & MPARSE_MAN) {

-               curp->man->macroset = MACROSET_MAN;
+               curp->man->meta.macroset = MACROSET_MAN;

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

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

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

+       tag_alloc();

        return curp;
 }
 
 void
 mparse_reset(struct mparse *curp)
 {
        return curp;
 }
 
 void
 mparse_reset(struct mparse *curp)
 {

+       tag_free();

        roff_reset(curp->roff);
        roff_man_reset(curp->man);
        free_buf_list(curp->secondary);
        curp->secondary = NULL;
        roff_reset(curp->roff);
        roff_man_reset(curp->man);
        free_buf_list(curp->secondary);
        curp->secondary = NULL;

-       free(curp->sodest);
-       curp->sodest = NULL;

        curp->gzip = 0;
        curp->gzip = 0;

+       tag_alloc();

 }
 
 void
 mparse_free(struct mparse *curp)
 {
 }
 
 void
 mparse_free(struct mparse *curp)
 {

+       tag_free();

        roffhash_free(curp->man->mdocmac);
        roffhash_free(curp->man->manmac);
        roff_man_free(curp->man);
        roff_free(curp->roff);
        free_buf_list(curp->secondary);
        roffhash_free(curp->man->mdocmac);
        roffhash_free(curp->man->manmac);
        roff_man_free(curp->man);
        roff_free(curp->roff);
        free_buf_list(curp->secondary);

-       free(curp->sodest);

        free(curp);
 }
 
        free(curp);
 }
 

-void
-mparse_result(struct mparse *curp, struct roff_man **man,
-       char **sodest)
+struct roff_meta *
+mparse_result(struct mparse *curp)

 {
 {

-
-       if (sodest && NULL != (*sodest = curp->sodest)) {
-               *man = NULL;
-               return;
+       roff_state_reset(curp->man);
+       if (curp->options & MPARSE_VALIDATE) {
+               if (curp->man->meta.macroset == MACROSET_MDOC)
+                       mdoc_validate(curp->man);
+               else
+                       man_validate(curp->man);
+               tag_postprocess(curp->man, curp->man->meta.first);

        }
        }

-       if (man)
-               *man = curp->man;
+       return &curp->man->meta;

 }
 
 void
 }
 
 void