[BACK]Return to read.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/read.c between version 1.26 and 1.215

version 1.26, 2011/11/07 01:24:40 version 1.215, 2020/03/13 15:32:28
Line 1 
Line 1 
 /*      $Id$ */  /* $Id$ */
 /*  /*
    * Copyright (c) 2010-2019 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, 2011 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   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.   * copyright notice and this permission notice appear in all copies.
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.   * 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.
  */   */
 #ifdef HAVE_CONFIG_H  
 #include "config.h"  #include "config.h"
 #endif  
   
 #ifdef HAVE_MMAP  #include <sys/types.h>
 # include <sys/stat.h>  #include <sys/mman.h>
 # include <sys/mman.h>  #include <sys/stat.h>
 #endif  
   
 #include <assert.h>  #include <assert.h>
 #include <ctype.h>  #include <ctype.h>
   #include <errno.h>
 #include <fcntl.h>  #include <fcntl.h>
 #include <stdarg.h>  #include <stdarg.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
 #include <unistd.h>  #include <unistd.h>
   #include <zlib.h>
   
   #include "mandoc_aux.h"
 #include "mandoc.h"  #include "mandoc.h"
 #include "libmandoc.h"  #include "roff.h"
   #include "tag.h"
 #include "mdoc.h"  #include "mdoc.h"
 #include "man.h"  #include "man.h"
   #include "mandoc_parse.h"
   #include "libmandoc.h"
   #include "roff_int.h"
   
 #ifndef MAP_FILE  
 #define MAP_FILE        0  
 #endif  
   
 #define REPARSE_LIMIT   1000  #define REPARSE_LIMIT   1000
   
 struct  buf {  
         char             *buf; /* binary input buffer */  
         size_t            sz; /* size of binary buffer */  
 };  
   
 struct  mparse {  struct  mparse {
         enum mandoclevel  file_status; /* status of current parse */  
         enum mandoclevel  wlevel; /* ignore messages below this */  
         int               line; /* line number in the file */  
         enum mparset      inttype; /* which parser to use */  
         struct man       *pman; /* persistent man parser */  
         struct mdoc      *pmdoc; /* persistent mdoc parser */  
         struct man       *man; /* man parser */  
         struct mdoc      *mdoc; /* mdoc parser */  
         struct roff      *roff; /* roff parser (!NULL) */          struct roff      *roff; /* roff parser (!NULL) */
           struct roff_man  *man; /* man parser */
           struct buf       *primary; /* buffer currently being parsed */
           struct buf       *secondary; /* copy of top level input */
           struct buf       *loop; /* open .while request line */
           const char       *os_s; /* default operating system */
           int               options; /* parser options */
           int               gzip; /* current input file is gzipped */
           int               filenc; /* encoding of the current file */
         int               reparse_count; /* finite interp. stack */          int               reparse_count; /* finite interp. stack */
         mandocmsg         mmsg; /* warning/error message handler */          int               line; /* line number in the file */
         void             *arg; /* argument to mmsg */  
         const char       *file;  
         struct buf       *secondary;  
 };  };
   
   static  void      choose_parser(struct mparse *);
   static  void      free_buf_list(struct buf *);
 static  void      resize_buf(struct buf *, size_t);  static  void      resize_buf(struct buf *, size_t);
 static  void      mparse_buf_r(struct mparse *, struct buf, int);  static  int       mparse_buf_r(struct mparse *, struct buf, size_t, int);
 static  void      mparse_readfd_r(struct mparse *, int, const char *, int);  static  int       read_whole_file(struct mparse *, int, struct buf *, int *);
 static  void      pset(const char *, int, struct mparse *);  
 static  void      pdesc(struct mparse *, const char *, int);  
 static  int       read_whole_file(const char *, int, struct buf *, int *);  
 static  void      mparse_end(struct mparse *);  static  void      mparse_end(struct mparse *);
   
 static  const enum mandocerr    mandoclimits[MANDOCLEVEL_MAX] = {  
         MANDOCERR_OK,  
         MANDOCERR_WARNING,  
         MANDOCERR_WARNING,  
         MANDOCERR_ERROR,  
         MANDOCERR_FATAL,  
         MANDOCERR_MAX,  
         MANDOCERR_MAX  
 };  
   
 static  const char * const      mandocerrs[MANDOCERR_MAX] = {  
         "ok",  
   
         "generic warning",  
   
         /* related to the prologue */  
         "no title in document",  
         "document title should be all caps",  
         "unknown manual section",  
         "date missing, using today's date",  
         "cannot parse date, using it verbatim",  
         "prologue macros out of order",  
         "duplicate prologue macro",  
         "macro not allowed in prologue",  
         "macro not allowed in body",  
   
         /* related to document structure */  
         ".so is fragile, better use ln(1)",  
         "NAME section must come first",  
         "bad NAME section contents",  
         "manual name not yet set",  
         "sections out of conventional order",  
         "duplicate section name",  
         "section not in conventional manual section",  
   
         /* related to macros and nesting */  
         "skipping obsolete macro",  
         "skipping paragraph macro",  
         "skipping no-space macro",  
         "blocks badly nested",  
         "child violates parent syntax",  
         "nested displays are not portable",  
         "already in literal mode",  
         "line scope broken",  
   
         /* related to missing macro arguments */  
         "skipping empty macro",  
         "argument count wrong",  
         "missing display type",  
         "list type must come first",  
         "tag lists require a width argument",  
         "missing font type",  
         "skipping end of block that is not open",  
   
         /* related to bad macro arguments */  
         "skipping argument",  
         "duplicate argument",  
         "duplicate display type",  
         "duplicate list type",  
         "unknown AT&T UNIX version",  
         "bad Boolean value",  
         "unknown font",  
         "unknown standard specifier",  
         "bad width argument",  
   
         /* related to plain text */  
         "blank line in non-literal context",  
         "tab in non-literal context",  
         "end of line whitespace",  
         "bad comment style",  
         "bad escape sequence",  
         "unterminated quoted string",  
   
         /* related to equations */  
         "unexpected literal in equation",  
   
         "generic error",  
   
         /* related to equations */  
         "unexpected equation scope closure",  
         "equation scope open on exit",  
         "overlapping equation scopes",  
         "unexpected end of equation",  
         "equation syntax error",  
   
         /* related to tables */  
         "bad table syntax",  
         "bad table option",  
         "bad table layout",  
         "no table layout cells specified",  
         "no table data cells specified",  
         "ignore data in cell",  
         "data block still open",  
         "ignoring extra data cells",  
   
         "input stack limit exceeded, infinite loop?",  
         "skipping bad character",  
         "escaped character not allowed in a name",  
         "skipping text before the first section header",  
         "skipping unknown macro",  
         "NOT IMPLEMENTED, please use groff: skipping request",  
         "argument count wrong",  
         "skipping end of block that is not open",  
         "missing end of block",  
         "scope open on exit",  
         "uname(3) system call failed",  
         "macro requires line argument(s)",  
         "macro requires body argument(s)",  
         "macro requires argument(s)",  
         "missing list type",  
         "line argument(s) will be lost",  
         "body argument(s) will be lost",  
   
         "generic fatal error",  
   
         "not a manual",  
         "column syntax is inconsistent",  
         "NOT IMPLEMENTED: .Bd -file",  
         "argument count wrong, violates syntax",  
         "child violates parent syntax",  
         "argument count wrong, violates syntax",  
         "NOT IMPLEMENTED: .so with absolute path or \"..\"",  
         "no document body",  
         "no document prologue",  
         "static buffer exhausted",  
 };  
   
 static  const char * const      mandoclevels[MANDOCLEVEL_MAX] = {  
         "SUCCESS",  
         "RESERVED",  
         "WARNING",  
         "ERROR",  
         "FATAL",  
         "BADARG",  
         "SYSERR"  
 };  
   
 static void  static void
 resize_buf(struct buf *buf, size_t initial)  resize_buf(struct buf *buf, size_t initial)
 {  {
Line 220  resize_buf(struct buf *buf, size_t initial)
Line 82  resize_buf(struct buf *buf, size_t initial)
 }  }
   
 static void  static void
 pset(const char *buf, int pos, struct mparse *curp)  free_buf_list(struct buf *buf)
 {  {
         int              i;          struct buf *tmp;
   
           while (buf != NULL) {
                   tmp = buf;
                   buf = tmp->next;
                   free(tmp->buf);
                   free(tmp);
           }
   }
   
   static void
   choose_parser(struct mparse *curp)
   {
           char            *cp, *ep;
           int              format;
   
         /*          /*
          * Try to intuit which kind of manual parser should be used.  If           * If neither command line arguments -mdoc or -man select
          * passed in by command-line (-man, -mdoc), then use that           * a parser nor the roff parser found a .Dd or .TH macro
          * explicitly.  If passed as -mandoc, then try to guess from the           * yet, look ahead in the main input buffer.
          * line: either skip dot-lines, use -mdoc when finding `.Dt', or  
          * default to -man, which is more lenient.  
          *  
          * Separate out pmdoc/pman from mdoc/man: the first persists  
          * through all parsers, while the latter is used per-parse.  
          */           */
   
         if ('.' == buf[0] || '\'' == buf[0]) {          if ((format = roff_getformat(curp->roff)) == 0) {
                 for (i = 1; buf[i]; i++)                  cp = curp->primary->buf;
                         if (' ' != buf[i] && '\t' != buf[i])                  ep = cp + curp->primary->sz;
                   while (cp < ep) {
                           if (*cp == '.' || *cp == '\'') {
                                   cp++;
                                   if (cp[0] == 'D' && cp[1] == 'd') {
                                           format = MPARSE_MDOC;
                                           break;
                                   }
                                   if (cp[0] == 'T' && cp[1] == 'H') {
                                           format = MPARSE_MAN;
                                           break;
                                   }
                           }
                           cp = memchr(cp, '\n', ep - cp);
                           if (cp == NULL)
                                 break;                                  break;
                 if ('\0' == buf[i])                          cp++;
                         return;                  }
         }          }
   
         switch (curp->inttype) {          if (format == MPARSE_MDOC) {
         case (MPARSE_MDOC):                  curp->man->meta.macroset = MACROSET_MDOC;
                 if (NULL == curp->pmdoc)                  if (curp->man->mdocmac == NULL)
                         curp->pmdoc = mdoc_alloc(curp->roff, curp);                          curp->man->mdocmac = roffhash_alloc(MDOC_Dd, MDOC_MAX);
                 assert(curp->pmdoc);          } else {
                 curp->mdoc = curp->pmdoc;                  curp->man->meta.macroset = MACROSET_MAN;
                 return;                  if (curp->man->manmac == NULL)
         case (MPARSE_MAN):                          curp->man->manmac = roffhash_alloc(MAN_TH, MAN_MAX);
                 if (NULL == curp->pman)  
                         curp->pman = man_alloc(curp->roff, curp);  
                 assert(curp->pman);  
                 curp->man = curp->pman;  
                 return;  
         default:  
                 break;  
         }          }
           curp->man->meta.first->tok = TOKEN_NONE;
         if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3))  {  
                 if (NULL == curp->pmdoc)  
                         curp->pmdoc = mdoc_alloc(curp->roff, curp);  
                 assert(curp->pmdoc);  
                 curp->mdoc = curp->pmdoc;  
                 return;  
         }  
   
         if (NULL == curp->pman)  
                 curp->pman = man_alloc(curp->roff, curp);  
         assert(curp->pman);  
         curp->man = curp->pman;  
 }  }
   
 /*  /*
  * Main parse routine for an opened file.  This is called for each   * Main parse routine for a buffer.
  * opened file and simply loops around the full input file, possibly   * It assumes encoding and line numbering are already set up.
  * nesting (i.e., with `so').   * It can recurse directly (for invocations of user-defined
    * 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, int start)  mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
 {  {
         const struct tbl_span   *span;  
         struct buf       ln;          struct buf       ln;
         enum rofferr     rr;          struct buf      *firstln, *lastln, *thisln, *loop;
         int              i, of, rc;          char            *cp;
         int              pos; /* byte number in the ln buffer */          size_t           pos; /* byte number in the ln buffer */
           int              line_result, result;
           int              of;
         int              lnn; /* line number in the real file */          int              lnn; /* line number in the real file */
           int              fd;
           int              inloop; /* Saw .while on this level. */
         unsigned char    c;          unsigned char    c;
   
         memset(&ln, 0, sizeof(struct buf));          ln.sz = 256;
           ln.buf = mandoc_malloc(ln.sz);
           ln.next = NULL;
           firstln = lastln = loop = NULL;
           lnn = curp->line;
           pos = 0;
           inloop = 0;
           result = ROFF_CONT;
   
         lnn = curp->line;          while (i < blk.sz && (blk.buf[i] != '\0' || pos != 0)) {
         pos = 0;  
   
         for (i = 0; i < (int)blk.sz; ) {  
                 if (0 == pos && '\0' == blk.buf[i])  
                         break;  
   
                 if (start) {                  if (start) {
                         curp->line = lnn;                          curp->line = lnn;
                         curp->reparse_count = 0;                          curp->reparse_count = 0;
   
                           if (lnn < 3 &&
                               curp->filenc & MPARSE_UTF8 &&
                               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,                           * When finding an unescaped newline character,
Line 312  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 189  mparse_buf_r(struct mparse *curp, struct buf blk, int 
                          * Skip a preceding carriage return, if any.                           * 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])                              '\n' == blk.buf[i + 1])
                                 ++i;                                  ++i;
                         if ('\n' == blk.buf[i]) {                          if ('\n' == blk.buf[i]) {
Line 321  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 198  mparse_buf_r(struct mparse *curp, struct buf blk, int 
                                 break;                                  break;
                         }                          }
   
                         /*                          /*
                          * Warn about bogus characters.  If you're using                           * Make sure we have space for the worst
                          * non-ASCII encoding, you're screwing your                           * case of 12 bytes: "\\[u10ffff]\n\0"
                          * readers.  Since I'd rather this not happen,  
                          * I'll be helpful and drop these characters so  
                          * we don't display gibberish.  Note to manual  
                          * writers: use special characters.  
                          */                           */
   
                         c = (unsigned char) blk.buf[i];                          if (pos + 12 > ln.sz)
                                   resize_buf(&ln, 256);
   
                         if ( ! (isascii(c) &&                          /*
                                         (isgraph(c) || isblank(c)))) {                           * Encode 8-bit input.
                                 mandoc_msg(MANDOCERR_BADCHAR, curp,                           */
                                                 curp->line, pos, "ignoring byte");  
                                 i++;  
                                 continue;  
                         }  
   
                         /* Trailing backslash = a plain char. */                          c = blk.buf[i];
                           if (c & 0x80) {
                         if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {                                  if ( ! (curp->filenc && preconv_encode(
                                 if (pos >= (int)ln.sz)                                      &blk, &i, &ln, &pos, &curp->filenc))) {
                                         resize_buf(&ln, 256);                                          mandoc_msg(MANDOCERR_CHAR_BAD,
                                 ln.buf[pos++] = blk.buf[i++];                                              curp->line, pos, "0x%x", c);
                                           ln.buf[pos++] = '?';
                                           i++;
                                   }
                                 continue;                                  continue;
                         }                          }
   
                         /*                          /*
                          * Found escape and at least one other character.                           * Exclude control characters.
                          * 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 < (int)blk.sz &&                          if (c == 0x7f || (c < 0x20 && c != 0x09)) {
                             '\n' == blk.buf[i + 2])                                  mandoc_msg(c == 0x00 || c == 0x04 ||
                                 ++i;                                      c > 0x0a ? MANDOCERR_CHAR_BAD :
                         if ('\n' == blk.buf[i + 1]) {                                      MANDOCERR_CHAR_UNSUPP,
                                 i += 2;                                      curp->line, pos, "0x%x", c);
                                 ++lnn;                                  i++;
                                   if (c != '\r')
                                           ln.buf[pos++] = '?';
                                 continue;                                  continue;
                         }                          }
   
                         if ('"' == blk.buf[i + 1] || '#' == blk.buf[i + 1]) {                          ln.buf[pos++] = blk.buf[i++];
                                 i += 2;                  }
                                 /* Comment, skip to end of line */                  ln.buf[pos] = '\0';
                                 for (; i < (int)blk.sz; ++i) {  
                                         if ('\n' == blk.buf[i]) {  
                                                 ++i;  
                                                 ++lnn;  
                                                 break;  
                                         }  
                                 }  
   
                                 /* Backout trailing whitespaces */                  /*
                                 for (; pos > 0; --pos) {                   * Maintain a lookaside buffer of all lines.
                                         if (ln.buf[pos - 1] != ' ')                   * parsed from this input source.
                                                 break;                   */
                                         if (pos > 2 && ln.buf[pos - 2] == '\\')  
                                                 break;  
                                 }  
                                 break;  
                         }  
   
                         /* Some other escape sequence, copy & cont. */                  thisln = mandoc_malloc(sizeof(*thisln));
                   thisln->buf = mandoc_strdup(ln.buf);
                   thisln->sz = strlen(ln.buf) + 1;
                   thisln->next = NULL;
                   if (firstln == NULL) {
                           firstln = lastln = thisln;
                           if (curp->secondary == NULL)
                                   curp->secondary = firstln;
                   } else {
                           lastln->next = thisln;
                           lastln = thisln;
                   }
   
                         if (pos + 1 >= (int)ln.sz)                  /* XXX Ugly hack to mark the end of the input. */
                                 resize_buf(&ln, 256);  
   
                         ln.buf[pos++] = blk.buf[i++];                  if (i == blk.sz || blk.buf[i] == '\0') {
                         ln.buf[pos++] = blk.buf[i++];                          if (pos + 2 > ln.sz)
                                   resize_buf(&ln, 256);
                           ln.buf[pos++] = '\n';
                           ln.buf[pos] = '\0';
                 }                  }
   
                 if (pos >= (int)ln.sz)  
                         resize_buf(&ln, 256);  
   
                 ln.buf[pos] = '\0';  
   
                 /*                  /*
                  * A significant amount of complexity is contained by                   * A significant amount of complexity is contained by
                  * the roff preprocessor.  It's line-oriented but can be                   * the roff preprocessor.  It's line-oriented but can be
Line 410  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 278  mparse_buf_r(struct mparse *curp, struct buf blk, int 
                  */                   */
   
                 of = 0;                  of = 0;
   rerun:
                   line_result = roff_parseln(curp->roff, curp->line, &ln, &of);
   
                 /*                  /* Process options. */
                  * Maintain a lookaside buffer of all parsed lines.  We  
                  * only do this if mparse_keep() has been invoked (the  
                  * buffer may be accessed with mparse_getkeep()).  
                  */  
   
                 if (curp->secondary) {                  if (line_result & ROFF_APPEND)
                         curp->secondary->buf =                          assert(line_result == (ROFF_IGN | ROFF_APPEND));
                                 mandoc_realloc  
                                 (curp->secondary->buf,                  if (line_result & ROFF_USERCALL)
                                  curp->secondary->sz + pos + 2);                          assert((line_result & ROFF_MASK) == ROFF_REPARSE);
                         memcpy(curp->secondary->buf +  
                                         curp->secondary->sz,                  if (line_result & ROFF_USERRET) {
                                         ln.buf, pos);                          assert(line_result == (ROFF_IGN | ROFF_USERRET));
                         curp->secondary->sz += pos;                          if (start == 0) {
                         curp->secondary->buf                                  /* Return from the current macro. */
                                 [curp->secondary->sz] = '\n';                                  result = ROFF_USERRET;
                         curp->secondary->sz++;                                  goto out;
                         curp->secondary->buf                          }
                                 [curp->secondary->sz] = '\0';  
                 }                  }
 rerun:  
                 rr = roff_parseln  
                         (curp->roff, curp->line,  
                          &ln.buf, &ln.sz, of, &of);  
   
                 switch (rr) {                  switch (line_result & ROFF_LOOPMASK) {
                 case (ROFF_REPARSE):                  case ROFF_IGN:
                         if (REPARSE_LIMIT >= ++curp->reparse_count)  
                                 mparse_buf_r(curp, ln, 0);  
                         else  
                                 mandoc_msg(MANDOCERR_ROFFLOOP, curp,  
                                         curp->line, pos, NULL);  
                         pos = 0;  
                         continue;  
                 case (ROFF_APPEND):  
                         pos = (int)strlen(ln.buf);  
                         continue;  
                 case (ROFF_RERUN):  
                         goto rerun;  
                 case (ROFF_IGN):  
                         pos = 0;  
                         continue;  
                 case (ROFF_ERR):  
                         assert(MANDOCLEVEL_FATAL <= curp->file_status);  
                         break;                          break;
                 case (ROFF_SO):                  case ROFF_WHILE:
                         /*                          if (curp->loop != NULL) {
                          * We remove `so' clauses from our lookaside                                  if (loop == curp->loop)
                          * buffer because we're going to descend into                                          break;
                          * the file recursively.                                  mandoc_msg(MANDOCERR_WHILE_NEST,
                          */                                      curp->line, pos, NULL);
                         if (curp->secondary)                          }
                                 curp->secondary->sz -= pos + 1;                          curp->loop = thisln;
                         mparse_readfd_r(curp, -1, ln.buf + of, 1);                          loop = NULL;
                         if (MANDOCLEVEL_FATAL <= curp->file_status)                          inloop = 1;
                           break;
                   case ROFF_LOOPCONT:
                   case ROFF_LOOPEXIT:
                           if (curp->loop == NULL) {
                                   mandoc_msg(MANDOCERR_WHILE_FAIL,
                                       curp->line, pos, NULL);
                                 break;                                  break;
                         pos = 0;                          }
                         continue;                          if (inloop == 0) {
                 default:                                  mandoc_msg(MANDOCERR_WHILE_INTO,
                                       curp->line, pos, NULL);
                                   curp->loop = loop = NULL;
                                   break;
                           }
                           if (line_result & ROFF_LOOPCONT)
                                   loop = curp->loop;
                           else {
                                   curp->loop = loop = NULL;
                                   inloop = 0;
                           }
                         break;                          break;
                   default:
                           abort();
                 }                  }
   
                 /*                  /* Process the main instruction from the roff parser. */
                  * If we encounter errors in the recursive parse, make  
                  * sure we don't continue parsing.  
                  */  
   
                 if (MANDOCLEVEL_FATAL <= curp->file_status)                  switch (line_result & ROFF_MASK) {
                   case ROFF_IGN:
                         break;                          break;
                   case ROFF_CONT:
                 /*                          if (curp->man->meta.macroset == MACROSET_NONE)
                  * If input parsers have not been allocated, do so now.                                  choose_parser(curp);
                  * We keep these instanced between parsers, but set them                          if ((curp->man->meta.macroset == MACROSET_MDOC ?
                  * locally per parse routine since we can use different                               mdoc_parseln(curp->man, curp->line, ln.buf, of) :
                  * parsers with each one.                               man_parseln(curp->man, curp->line, ln.buf, of)
                  */                              ) == 2)
                                   goto out;
                 if ( ! (curp->man || curp->mdoc))                          break;
                         pset(ln.buf + of, pos - of, curp);                  case ROFF_RERUN:
                           goto rerun;
                 /*                  case ROFF_REPARSE:
                  * Lastly, push down into the parsers themselves.  One                          if (++curp->reparse_count > REPARSE_LIMIT) {
                  * of these will have already been set in the pset()                                  /* Abort and return to the top level. */
                  * routine.                                  result = ROFF_IGN;
                  * If libroff returns ROFF_TBL, then add it to the                                  mandoc_msg(MANDOCERR_ROFFLOOP,
                  * currently open parse.  Since we only get here if                                      curp->line, pos, NULL);
                  * there does exist data (see tbl_data.c), we're                                  goto out;
                  * guaranteed that something's been allocated.  
                  * 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)                          result = mparse_buf_r(curp, ln, of, 0);
                         rc = curp->mdoc ?                          if (line_result & ROFF_USERCALL) {
                                 mdoc_addeqn(curp->mdoc,                                  roff_userret(curp->roff);
                                         roff_eqn(curp->roff)) :                                  /* Continue normally. */
                                 man_addeqn(curp->man,                                  if (result & ROFF_USERRET)
                                         roff_eqn(curp->roff));                                          result = ROFF_CONT;
                 else if (curp->man || curp->mdoc)                          }
                         rc = curp->man ?                          if (start == 0 && result != ROFF_CONT)
                                 man_parseln(curp->man,                                  goto out;
                                         curp->line, ln.buf, of) :  
                                 mdoc_parseln(curp->mdoc,  
                                         curp->line, ln.buf, of);  
   
                 if (0 == rc) {  
                         assert(MANDOCLEVEL_FATAL <= curp->file_status);  
                         break;                          break;
                   case ROFF_SO:
                           if ( ! (curp->options & MPARSE_SO) &&
                               (i >= blk.sz || blk.buf[i] == '\0')) {
                                   curp->man->meta.sodest =
                                       mandoc_strdup(ln.buf + of);
                                   goto out;
                           }
                           if ((fd = mparse_open(curp, ln.buf + of)) != -1) {
                                   mparse_readfd(curp, fd, ln.buf + of);
                                   close(fd);
                           } else {
                                   mandoc_msg(MANDOCERR_SO_FAIL,
                                       curp->line, of, ".so %s: %s",
                                       ln.buf + of, strerror(errno));
                                   ln.sz = mandoc_asprintf(&cp,
                                       ".sp\nSee the file %s.\n.sp",
                                       ln.buf + of);
                                   free(ln.buf);
                                   ln.buf = cp;
                                   of = 0;
                                   mparse_buf_r(curp, ln, of, 0);
                           }
                           break;
                   default:
                           abort();
                 }                  }
   
                 /* Temporary buffers typically are not full. */                  /* Start the next input line. */
   
                 if (0 == start && '\0' == blk.buf[i])                  if (loop != NULL &&
                         break;                      (line_result & ROFF_LOOPMASK) == ROFF_IGN)
                           loop = loop->next;
   
                 /* Start the next input line. */                  if (loop != NULL) {
                           if ((line_result & ROFF_APPEND) == 0)
                                   *ln.buf = '\0';
                           if (ln.sz < loop->sz)
                                   resize_buf(&ln, loop->sz);
                           (void)strlcat(ln.buf, loop->buf, ln.sz);
                           of = 0;
                           goto rerun;
                   }
   
                 pos = 0;                  pos = (line_result & ROFF_APPEND) ? strlen(ln.buf) : 0;
         }          }
   out:
           if (inloop) {
                   if (result != ROFF_USERRET)
                           mandoc_msg(MANDOCERR_WHILE_OUTOF,
                               curp->line, pos, NULL);
                   curp->loop = NULL;
           }
         free(ln.buf);          free(ln.buf);
           if (firstln != curp->secondary)
                   free_buf_list(firstln);
           return result;
 }  }
   
 static void  
 pdesc(struct mparse *curp, const char *file, int fd)  
 {  
         struct buf       blk;  
         int              with_mmap;  
   
         /*  
          * 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.  
          */  
   
         if ( ! read_whole_file(file, fd, &blk, &with_mmap)) {  
                 curp->file_status = MANDOCLEVEL_SYSERR;  
                 return;  
         }  
   
         /* Line number is per-file. */  
   
         curp->line = 1;  
   
         mparse_buf_r(curp, blk, 1);  
   
 #ifdef  HAVE_MMAP  
         if (with_mmap)  
                 munmap(blk.buf, blk.sz);  
         else  
 #endif  
                 free(blk.buf);  
 }  
   
 static int  static int
 read_whole_file(const char *file, int fd, struct buf *fb, int *with_mmap)  read_whole_file(struct mparse *curp, int fd, struct buf *fb, int *with_mmap)
 {  {
           struct stat      st;
           gzFile           gz;
         size_t           off;          size_t           off;
         ssize_t          ssz;          ssize_t          ssz;
           int              gzerrnum, retval;
   
 #ifdef  HAVE_MMAP          if (fstat(fd, &st) == -1) {
         struct stat      st;                  mandoc_msg(MANDOCERR_FSTAT, 0, 0, "%s", strerror(errno));
         if (-1 == fstat(fd, &st)) {                  return -1;
                 perror(file);  
                 return(0);  
         }          }
   
         /*          /*
Line 596  read_whole_file(const char *file, int fd, struct buf *
Line 449  read_whole_file(const char *file, int fd, struct buf *
          * concerned that this is going to tank any machines.           * concerned that this is going to tank any machines.
          */           */
   
         if (S_ISREG(st.st_mode)) {          if (curp->gzip == 0 && S_ISREG(st.st_mode)) {
                 if (st.st_size >= (1U << 31)) {                  if (st.st_size > 0x7fffffff) {
                         fprintf(stderr, "%s: input too large\n", file);                          mandoc_msg(MANDOCERR_TOOLARGE, 0, 0, NULL);
                         return(0);                          return -1;
                 }                  }
                 *with_mmap = 1;                  *with_mmap = 1;
                 fb->sz = (size_t)st.st_size;                  fb->sz = (size_t)st.st_size;
                 fb->buf = mmap(NULL, fb->sz, PROT_READ,                  fb->buf = mmap(NULL, fb->sz, PROT_READ, MAP_SHARED, fd, 0);
                                 MAP_FILE|MAP_SHARED, fd, 0);  
                 if (fb->buf != MAP_FAILED)                  if (fb->buf != MAP_FAILED)
                         return(1);                          return 0;
         }          }
 #endif  
   
           if (curp->gzip) {
                   /*
                    * Duplicating the file descriptor is required
                    * because we will have to call gzclose(3)
                    * to free memory used internally by zlib,
                    * but that will also close the file descriptor,
                    * which this function must not do.
                    */
                   if ((fd = dup(fd)) == -1) {
                           mandoc_msg(MANDOCERR_DUP, 0, 0,
                               "%s", strerror(errno));
                           return -1;
                   }
                   if ((gz = gzdopen(fd, "rb")) == NULL) {
                           mandoc_msg(MANDOCERR_GZDOPEN, 0, 0,
                               "%s", strerror(errno));
                           close(fd);
                           return -1;
                   }
           } else
                   gz = NULL;
   
         /*          /*
          * If this isn't a regular file (like, say, stdin), then we must           * If this isn't a regular file (like, say, stdin), then we must
          * go the old way and just read things in bit by bit.           * go the old way and just read things in bit by bit.
Line 617  read_whole_file(const char *file, int fd, struct buf *
Line 490  read_whole_file(const char *file, int fd, struct buf *
   
         *with_mmap = 0;          *with_mmap = 0;
         off = 0;          off = 0;
           retval = -1;
         fb->sz = 0;          fb->sz = 0;
         fb->buf = NULL;          fb->buf = NULL;
         for (;;) {          for (;;) {
                 if (off == fb->sz) {                  if (off == fb->sz) {
                         if (fb->sz == (1U << 31)) {                          if (fb->sz == (1U << 31)) {
                                 fprintf(stderr, "%s: input too large\n", file);                                  mandoc_msg(MANDOCERR_TOOLARGE, 0, 0, NULL);
                                 break;                                  break;
                         }                          }
                         resize_buf(fb, 65536);                          resize_buf(fb, 65536);
                 }                  }
                 ssz = read(fd, fb->buf + (int)off, fb->sz - off);                  ssz = curp->gzip ?
                       gzread(gz, fb->buf + (int)off, fb->sz - off) :
                       read(fd, fb->buf + (int)off, fb->sz - off);
                 if (ssz == 0) {                  if (ssz == 0) {
                         fb->sz = off;                          fb->sz = off;
                         return(1);                          retval = 0;
                           break;
                 }                  }
                 if (ssz == -1) {                  if (ssz == -1) {
                         perror(file);                          if (curp->gzip)
                                   (void)gzerror(gz, &gzerrnum);
                           mandoc_msg(MANDOCERR_READ, 0, 0, "%s",
                               curp->gzip && gzerrnum != Z_ERRNO ?
                               zError(gzerrnum) : strerror(errno));
                         break;                          break;
                 }                  }
                 off += (size_t)ssz;                  off += (size_t)ssz;
         }          }
   
         free(fb->buf);          if (curp->gzip && (gzerrnum = gzclose(gz)) != Z_OK)
         fb->buf = NULL;                  mandoc_msg(MANDOCERR_GZCLOSE, 0, 0, "%s",
         return(0);                      gzerrnum == Z_ERRNO ? strerror(errno) :
                       zError(gzerrnum));
           if (retval == -1) {
                   free(fb->buf);
                   fb->buf = NULL;
           }
           return retval;
 }  }
   
 static void  static void
 mparse_end(struct mparse *curp)  mparse_end(struct mparse *curp)
 {  {
           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);
           roff_endparse(curp->roff);
   }
   
         if (MANDOCLEVEL_FATAL <= curp->file_status)  /*
                 return;   * Read the whole file into memory and call the parsers.
    * Called recursively when an .so request is encountered.
    */
   void
   mparse_readfd(struct mparse *curp, int fd, const char *filename)
   {
           static int       recursion_depth;
   
         if (curp->mdoc && ! mdoc_endparse(curp->mdoc)) {          struct buf       blk;
                 assert(MANDOCLEVEL_FATAL <= curp->file_status);          struct buf      *save_primary;
                 return;          const char      *save_filename;
         }          size_t           offset;
           int              save_filenc, save_lineno;
           int              with_mmap;
   
         if (curp->man && ! man_endparse(curp->man)) {          if (recursion_depth > 64) {
                 assert(MANDOCLEVEL_FATAL <= curp->file_status);                  mandoc_msg(MANDOCERR_ROFFLOOP, curp->line, 0, NULL);
                 return;                  return;
         }          }
           if (read_whole_file(curp, fd, &blk, &with_mmap) == -1)
         if ( ! (curp->man || curp->mdoc)) {  
                 mandoc_msg(MANDOCERR_NOTMANUAL, curp, 1, 0, NULL);  
                 curp->file_status = MANDOCLEVEL_FATAL;  
                 return;                  return;
         }  
   
         roff_endparse(curp->roff);          /*
 }           * Save some properties of the parent file.
            */
   
 static void          save_primary = curp->primary;
 mparse_readfd_r(struct mparse *curp, int fd, const char *file, int re)          save_filenc = curp->filenc;
 {          save_lineno = curp->line;
         const char      *svfile;          save_filename = mandoc_msg_getinfilename();
   
         if (-1 == fd)          curp->primary = &blk;
                 if (-1 == (fd = open(file, O_RDONLY, 0))) {          curp->filenc = curp->options & (MPARSE_UTF8 | MPARSE_LATIN1);
                         perror(file);          curp->line = 1;
                         curp->file_status = MANDOCLEVEL_SYSERR;          mandoc_msg_setinfilename(filename);
                         return;  
                 }  
   
         svfile = curp->file;          /* Skip an UTF-8 byte order mark. */
         curp->file = file;          if (curp->filenc & MPARSE_UTF8 && blk.sz > 2 &&
               (unsigned char)blk.buf[0] == 0xef &&
               (unsigned char)blk.buf[1] == 0xbb &&
               (unsigned char)blk.buf[2] == 0xbf) {
                   offset = 3;
                   curp->filenc &= ~MPARSE_LATIN1;
           } else
                   offset = 0;
   
         pdesc(curp, file, fd);          recursion_depth++;
           mparse_buf_r(curp, blk, offset, 1);
         if (0 == re && MANDOCLEVEL_FATAL > curp->file_status)          if (--recursion_depth == 0)
                 mparse_end(curp);                  mparse_end(curp);
   
         if (STDIN_FILENO != fd && -1 == close(fd))          /*
                 perror(file);           * Clean up and restore saved parent properties.
            */
   
         curp->file = svfile;          if (with_mmap)
                   munmap(blk.buf, blk.sz);
           else
                   free(blk.buf);
   
           curp->primary = save_primary;
           curp->filenc = save_filenc;
           curp->line = save_lineno;
           if (save_filename != NULL)
                   mandoc_msg_setinfilename(save_filename);
 }  }
   
 enum mandoclevel  int
 mparse_readfd(struct mparse *curp, int fd, const char *file)  mparse_open(struct mparse *curp, const char *file)
 {  {
           char             *cp;
           int               fd, save_errno;
   
         mparse_readfd_r(curp, fd, file, 0);          cp = strrchr(file, '.');
         return(curp->file_status);          curp->gzip = (cp != NULL && ! strcmp(cp + 1, "gz"));
   
           /* First try to use the filename as it is. */
   
           if ((fd = open(file, O_RDONLY)) != -1)
                   return fd;
   
           /*
            * If that doesn't work and the filename doesn't
            * already  end in .gz, try appending .gz.
            */
   
           if ( ! curp->gzip) {
                   save_errno = errno;
                   mandoc_asprintf(&cp, "%s.gz", file);
                   fd = open(cp, O_RDONLY);
                   free(cp);
                   errno = save_errno;
                   if (fd != -1) {
                           curp->gzip = 1;
                           return fd;
                   }
           }
   
           /* Neither worked, give up. */
   
           return -1;
 }  }
   
 struct mparse *  struct mparse *
 mparse_alloc(enum mparset inttype, enum mandoclevel wlevel, mandocmsg mmsg, void *arg)  mparse_alloc(int options, enum mandoc_os os_e, const char *os_s)
 {  {
         struct mparse   *curp;          struct mparse   *curp;
   
         assert(wlevel <= MANDOCLEVEL_FATAL);  
   
         curp = mandoc_calloc(1, sizeof(struct mparse));          curp = mandoc_calloc(1, sizeof(struct mparse));
   
         curp->wlevel = wlevel;          curp->options = options;
         curp->mmsg = mmsg;          curp->os_s = os_s;
         curp->arg = arg;  
         curp->inttype = inttype;  
   
         curp->roff = roff_alloc(curp);          curp->roff = roff_alloc(options);
         return(curp);          curp->man = roff_man_alloc(curp->roff, curp->os_s,
                   curp->options & MPARSE_QUICK ? 1 : 0);
           if (curp->options & MPARSE_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) {
                   curp->man->meta.macroset = MACROSET_MAN;
                   if (curp->man->manmac == NULL)
                           curp->man->manmac = roffhash_alloc(MAN_TH, MAN_MAX);
           }
           curp->man->meta.first->tok = TOKEN_NONE;
           curp->man->meta.os_e = os_e;
           tag_alloc();
           return curp;
 }  }
   
 void  void
 mparse_reset(struct mparse *curp)  mparse_reset(struct mparse *curp)
 {  {
   
         roff_reset(curp->roff);          roff_reset(curp->roff);
           roff_man_reset(curp->man);
         if (curp->mdoc)          free_buf_list(curp->secondary);
                 mdoc_reset(curp->mdoc);          curp->secondary = NULL;
         if (curp->man)          curp->gzip = 0;
                 man_reset(curp->man);  
         if (curp->secondary)  
                 curp->secondary->sz = 0;  
   
         curp->file_status = MANDOCLEVEL_OK;  
         curp->mdoc = NULL;  
         curp->man = NULL;  
 }  }
   
 void  void
 mparse_free(struct mparse *curp)  mparse_free(struct mparse *curp)
 {  {
           tag_free();
         if (curp->pmdoc)          roffhash_free(curp->man->mdocmac);
                 mdoc_free(curp->pmdoc);          roffhash_free(curp->man->manmac);
         if (curp->pman)          roff_man_free(curp->man);
                 man_free(curp->pman);          roff_free(curp->roff);
         if (curp->roff)          free_buf_list(curp->secondary);
                 roff_free(curp->roff);  
         if (curp->secondary)  
                 free(curp->secondary->buf);  
   
         free(curp->secondary);  
         free(curp);          free(curp);
 }  }
   
 void  struct roff_meta *
 mparse_result(struct mparse *curp, struct mdoc **mdoc, struct man **man)  mparse_result(struct mparse *curp)
 {  {
           roff_state_reset(curp->man);
         if (mdoc)          if (curp->options & MPARSE_VALIDATE) {
                 *mdoc = curp->mdoc;                  if (curp->man->meta.macroset == MACROSET_MDOC)
         if (man)                          mdoc_validate(curp->man);
                 *man = curp->man;                  else
                           man_validate(curp->man);
           }
           return &curp->man->meta;
 }  }
   
 void  void
 mandoc_vmsg(enum mandocerr t, struct mparse *m,  mparse_copy(const struct mparse *p)
                 int ln, int pos, const char *fmt, ...)  
 {  {
         char             buf[256];          struct buf      *buf;
         va_list          ap;  
   
         va_start(ap, fmt);          for (buf = p->secondary; buf != NULL; buf = buf->next)
         vsnprintf(buf, sizeof(buf) - 1, fmt, ap);                  puts(buf->buf);
         va_end(ap);  
   
         mandoc_msg(t, m, ln, pos, buf);  
 }  
   
 void  
 mandoc_msg(enum mandocerr er, struct mparse *m,  
                 int ln, int col, const char *msg)  
 {  
         enum mandoclevel level;  
   
         level = MANDOCLEVEL_FATAL;  
         while (er < mandoclimits[level])  
                 level--;  
   
         if (level < m->wlevel)  
                 return;  
   
         if (m->mmsg)  
                 (*m->mmsg)(er, level, m->file, ln, col, msg);  
   
         if (m->file_status < level)  
                 m->file_status = level;  
 }  
   
 const char *  
 mparse_strerror(enum mandocerr er)  
 {  
   
         return(mandocerrs[er]);  
 }  
   
 const char *  
 mparse_strlevel(enum mandoclevel lvl)  
 {  
         return(mandoclevels[lvl]);  
 }  
   
 void  
 mparse_keep(struct mparse *p)  
 {  
   
         assert(NULL == p->secondary);  
         p->secondary = mandoc_calloc(1, sizeof(struct buf));  
 }  
   
 const char *  
 mparse_getkeep(const struct mparse *p)  
 {  
   
         assert(p->secondary);  
         return(p->secondary->sz ? p->secondary->buf : NULL);  
 }  }
Legend:
Removed from v.1.26  
changed lines
  Added in v.1.215
CVSweb