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

Diff for /mandoc/read.c between version 1.5 and 1.198

version 1.5, 2011/03/22 09:50:11 version 1.198, 2018/08/23 19:33:27
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * 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-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   * 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.
  */   */
 #include <sys/stat.h>  #include "config.h"
   
   #include <sys/types.h>
 #include <sys/mman.h>  #include <sys/mman.h>
   #include <sys/stat.h>
   
 #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 "mdoc.h"  #include "mdoc.h"
 #include "man.h"  #include "man.h"
   #include "libmandoc.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 regset     regs; /* roff registers */          struct roff_man  *man; /* man parser */
         int               reparse_count; /* finite interp. stack */          char             *sodest; /* filename pointed to by .so */
           const char       *file; /* filename of current input file */
           struct buf       *primary; /* buffer currently being parsed */
           struct buf       *secondary; /* copy of top level input */
           const char       *os_s; /* default operating system */
         mandocmsg         mmsg; /* warning/error message handler */          mandocmsg         mmsg; /* warning/error message handler */
         void             *arg; /* argument to mmsg */          enum mandoclevel  file_status; /* status of current parse */
         const char       *file;          enum mandocerr    mmin; /* ignore messages below this */
           int               options; /* parser options */
           int               gzip; /* current input file is gzipped */
           int               filenc; /* encoding of the current file */
           int               reparse_count; /* finite interp. stack */
           int               line; /* line number in the file */
 };  };
   
   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  enum rofferr 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 *, const char *, int,
 static  void      pset(const char *, int, struct mparse *);                                  struct buf *, int *);
 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  void      mparse_parse_buffer(struct mparse *, struct buf,
                           const char *);
   
 static  const enum mandocerr    mandoclimits[MANDOCLEVEL_MAX] = {  static  const enum mandocerr    mandoclimits[MANDOCLEVEL_MAX] = {
         MANDOCERR_OK,          MANDOCERR_OK,
           MANDOCERR_OK,
         MANDOCERR_WARNING,          MANDOCERR_WARNING,
         MANDOCERR_WARNING,  
         MANDOCERR_ERROR,          MANDOCERR_ERROR,
         MANDOCERR_FATAL,          MANDOCERR_UNSUPP,
         MANDOCERR_MAX,          MANDOCERR_MAX,
         MANDOCERR_MAX          MANDOCERR_MAX
 };  };
   
   static  const char * const      mandocerrs[MANDOCERR_MAX] = {
           "ok",
   
           "base system convention",
   
           "Mdocdate found",
           "Mdocdate missing",
           "unknown architecture",
           "operating system explicitly specified",
           "RCS id missing",
           "referenced manual not found",
   
           "generic style suggestion",
   
           "legacy man(7) date format",
           "normalizing date format to",
           "lower case character in document title",
           "duplicate RCS id",
           "possible typo in section name",
           "unterminated quoted argument",
           "useless macro",
           "consider using OS macro",
           "errnos out of order",
           "duplicate errno",
           "trailing delimiter",
           "no blank before trailing delimiter",
           "fill mode already enabled, skipping",
           "fill mode already disabled, skipping",
           "verbatim \"--\", maybe consider using \\(em",
           "function name without markup",
           "whitespace at end of input line",
           "bad comment style",
   
           "generic warning",
   
           /* related to the prologue */
           "missing manual title, using UNTITLED",
           "missing manual title, using \"\"",
           "missing manual section, using \"\"",
           "unknown manual section",
           "missing date, using today's date",
           "cannot parse date, using it verbatim",
           "date in the future, using it anyway",
           "missing Os macro, using \"\"",
           "late prologue macro",
           "prologue macros out of order",
   
           /* related to document structure */
           ".so is fragile, better use ln(1)",
           "no document body",
           "content before first section header",
           "first section is not \"NAME\"",
           "NAME section without Nm before Nd",
           "NAME section without description",
           "description not at the end of NAME",
           "bad NAME section content",
           "missing comma before name",
           "missing description line, using \"\"",
           "description line outside NAME section",
           "sections out of conventional order",
           "duplicate section title",
           "unexpected section",
           "cross reference to self",
           "unusual Xr order",
           "unusual Xr punctuation",
           "AUTHORS section without An macro",
   
           /* 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",
           "blocks badly nested",
           "nested displays are not portable",
           "moving content out of list",
           "first macro on line",
           "line scope broken",
           "skipping blank line in line scope",
   
           /* related to missing macro arguments */
           "skipping empty request",
           "conditional request controls empty scope",
           "skipping empty macro",
           "empty block",
           "empty argument, using 0n",
           "missing display type, using -ragged",
           "list type is not the first argument",
           "missing -width in -tag list, using 6n",
           "missing utility name, using \"\"",
           "missing function name, using \"\"",
           "empty head in list item",
           "empty list item",
           "missing argument, using next line",
           "missing font type, using \\fR",
           "unknown font type, using \\fR",
           "nothing follows prefix",
           "empty reference block",
           "missing section argument",
           "missing -std argument, adding it",
           "missing option string, using \"\"",
           "missing resource identifier, using \"\"",
           "missing eqn box, using \"\"",
   
           /* related to bad macro arguments */
           "duplicate argument",
           "skipping duplicate argument",
           "skipping duplicate display type",
           "skipping duplicate list type",
           "skipping -width argument",
           "wrong number of cells",
           "unknown AT&T UNIX version",
           "comma in function argument",
           "parenthesis in function name",
           "unknown library name",
           "invalid content in Rs block",
           "invalid Boolean argument",
           "unknown font, skipping request",
           "odd number of characters in request",
   
           /* related to plain text */
           "blank line in fill mode, using .sp",
           "tab in filled text",
           "new sentence, new line",
           "invalid escape sequence",
           "undefined string, using \"\"",
   
           /* related to tables */
           "tbl line starts with span",
           "tbl column starts with span",
           "skipping vertical bar in tbl layout",
   
           "generic error",
   
           /* related to tables */
           "non-alphabetic character in tbl options",
           "skipping unknown tbl option",
           "missing tbl option argument",
           "wrong tbl option argument size",
           "empty tbl layout",
           "invalid character in tbl layout",
           "unmatched parenthesis in tbl layout",
           "tbl without any data cells",
           "ignoring data in spanned tbl cell",
           "ignoring extra tbl data cells",
           "data block open at end of tbl",
   
           /* related to document structure and macros */
           NULL,
           "duplicate prologue macro",
           "skipping late title macro",
           "input stack limit exceeded, infinite loop?",
           "skipping bad character",
           "skipping unknown macro",
           "ignoring request outside macro",
           "skipping insecure request",
           "skipping item outside list",
           "skipping column outside column list",
           "skipping end of block that is not open",
           "fewer RS blocks open, skipping",
           "inserting missing end of block",
           "appending missing end of block",
   
           /* related to request and macro arguments */
           "escaped character not allowed in a name",
           "using macro argument outside macro",
           "argument number is not numeric",
           "NOT IMPLEMENTED: Bd -file",
           "skipping display without arguments",
           "missing list type, using -item",
           "argument is not numeric, using 1",
           "missing manual name, using \"\"",
           "uname(3) system call failed, using UNKNOWN",
           "unknown standard specifier",
           "skipping request without numeric argument",
           "excessive shift",
           "NOT IMPLEMENTED: .so with absolute path or \"..\"",
           ".so request failed",
           "skipping all arguments",
           "skipping excess arguments",
           "divide by zero",
   
           "unsupported feature",
           "input too large",
           "unsupported control character",
           "unsupported roff request",
           "eqn delim option in tbl",
           "unsupported tbl layout modifier",
           "ignoring macro in table",
   };
   
   static  const char * const      mandoclevels[MANDOCLEVEL_MAX] = {
           "SUCCESS",
           "STYLE",
           "WARNING",
           "ERROR",
           "UNSUPP",
           "BADARG",
           "SYSERR"
   };
   
   
 static void  static void
 resize_buf(struct buf *buf, size_t initial)  resize_buf(struct buf *buf, size_t initial)
 {  {
Line 87  resize_buf(struct buf *buf, size_t initial)
Line 291  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->macroset = MACROSET_MDOC;
                 if (NULL == curp->pmdoc)                  if (curp->man->mdocmac == NULL)
                         curp->pmdoc = mdoc_alloc(&curp->regs, curp);                          curp->man->mdocmac = roffhash_alloc(MDOC_Dd, MDOC_MAX);
                 assert(curp->pmdoc);          } else {
                 curp->mdoc = curp->pmdoc;                  curp->man->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->regs, curp);  
                 assert(curp->pman);  
                 curp->man = curp->pman;  
                 return;  
         default:  
                 break;  
         }          }
           curp->man->first->tok = TOKEN_NONE;
         if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3))  {  
                 if (NULL == curp->pmdoc)  
                         curp->pmdoc = mdoc_alloc(&curp->regs, curp);  
                 assert(curp->pmdoc);  
                 curp->mdoc = curp->pmdoc;  
                 return;  
         }  
   
         if (NULL == curp->pman)  
                 curp->pman = man_alloc(&curp->regs, 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 enum rofferr
 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;
         int              i, of, rc;          const char      *save_file;
         int              pos; /* byte number in the ln buffer */          char            *cp;
           size_t           pos; /* byte number in the ln buffer */
           enum rofferr     line_result, result;
           int              of;
         int              lnn; /* line number in the real file */          int              lnn; /* line number in the real file */
           int              fd;
         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 = NULL;
           lnn = curp->line;
           pos = 0;
           result = ROFF_CONT;
   
         lnn = curp->line;          while (i < blk.sz) {
         pos = 0;  
   
         for (i = 0; i < (int)blk.sz; ) {  
                 if (0 == pos && '\0' == blk.buf[i])                  if (0 == pos && '\0' == blk.buf[i])
                         break;                          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 179  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 400  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 188  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 409  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_vmsg(MANDOCERR_CHAR_BAD, curp,
                                 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_vmsg(c == 0x00 || c == 0x04 ||
                                 ++i;                                      c > 0x0a ? MANDOCERR_CHAR_BAD :
                         if ('\n' == blk.buf[i + 1]) {                                      MANDOCERR_CHAR_UNSUPP,
                                 i += 2;                                      curp, curp->line, pos, "0x%x", c);
                                 ++lnn;                                  i++;
                                   if (c != '\r')
                                           ln.buf[pos++] = '?';
                                 continue;                                  continue;
                         }                          }
   
                         if ('"' == 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++];                          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 277  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 487  mparse_buf_r(struct mparse *curp, struct buf blk, int 
                  */                   */
   
                 of = 0;                  of = 0;
   
 rerun:  rerun:
                 rr = roff_parseln                  line_result = roff_parseln(curp->roff, curp->line, &ln, &of);
                         (curp->roff, curp->line,  
                          &ln.buf, &ln.sz, of, &of);  
   
                 switch (rr) {                  switch (line_result) {
                 case (ROFF_REPARSE):                  case ROFF_REPARSE:
                         if (REPARSE_LIMIT >= ++curp->reparse_count)                  case ROFF_USERCALL:
                                 mparse_buf_r(curp, ln, 0);                          if (++curp->reparse_count > REPARSE_LIMIT) {
                         else                                  result = ROFF_IGN;
                                 mandoc_msg(MANDOCERR_ROFFLOOP, curp,                                  mandoc_msg(MANDOCERR_ROFFLOOP, curp,
                                         curp->line, pos, NULL);                                      curp->line, pos, NULL);
                         pos = 0;                          } else {
                                   result = mparse_buf_r(curp, ln, of, 0);
                                   if (line_result == ROFF_USERCALL) {
                                           if (result == ROFF_USERRET)
                                                   result = ROFF_CONT;
                                           roff_userret(curp->roff);
                                   }
                                   if (start || result == ROFF_CONT) {
                                           pos = 0;
                                           continue;
                                   }
                           }
                           goto out;
                   case ROFF_USERRET:
                           if (start) {
                                   pos = 0;
                                   continue;
                           }
                           result = ROFF_USERRET;
                           goto out;
                   case ROFF_APPEND:
                           pos = strlen(ln.buf);
                         continue;                          continue;
                 case (ROFF_APPEND):                  case ROFF_RERUN:
                         pos = (int)strlen(ln.buf);  
                         continue;  
                 case (ROFF_RERUN):  
                         goto rerun;                          goto rerun;
                 case (ROFF_IGN):                  case ROFF_IGN:
                         pos = 0;                          pos = 0;
                         continue;                          continue;
                 case (ROFF_ERR):                  case ROFF_SO:
                         assert(MANDOCLEVEL_FATAL <= curp->file_status);                          if ( ! (curp->options & MPARSE_SO) &&
                         break;                              (i >= blk.sz || blk.buf[i] == '\0')) {
                 case (ROFF_SO):                                  curp->sodest = mandoc_strdup(ln.buf + of);
                         mparse_readfd_r(curp, -1, ln.buf + of, 1);                                  goto out;
                         if (MANDOCLEVEL_FATAL <= curp->file_status)                          }
                                 break;                          save_file = curp->file;
                           if ((fd = mparse_open(curp, ln.buf + of)) != -1) {
                                   mparse_readfd(curp, fd, ln.buf + of);
                                   close(fd);
                                   curp->file = save_file;
                           } else {
                                   curp->file = save_file;
                                   mandoc_vmsg(MANDOCERR_SO_FAIL,
                                       curp, curp->line, pos,
                                       ".so %s", ln.buf + of);
                                   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);
                           }
                         pos = 0;                          pos = 0;
                         continue;                          continue;
                 default:                  default:
                         break;                          break;
                 }                  }
   
                 /*                  if (curp->man->macroset == MACROSET_NONE)
                  * If we encounter errors in the recursive parse, make                          choose_parser(curp);
                  * sure we don't continue parsing.  
                  */  
   
                 if (MANDOCLEVEL_FATAL <= curp->file_status)                  if ((curp->man->macroset == MACROSET_MDOC ?
                         break;                      mdoc_parseln(curp->man, curp->line, ln.buf, of) :
                       man_parseln(curp->man, curp->line, ln.buf, of)) == 2)
                                   break;
   
                 /*  
                  * If input parsers have not been allocated, do so now.  
                  * We keep these instanced betwen parsers, but set them  
                  * locally per parse routine since we can use different  
                  * parsers with each one.  
                  */  
   
                 if ( ! (curp->man || curp->mdoc))  
                         pset(ln.buf + of, pos - of, curp);  
   
                 /*  
                  * Lastly, push down into the parsers themselves.  One  
                  * of these will have already been set in the pset()  
                  * routine.  
                  * If libroff returns ROFF_TBL, then add it to the  
                  * currently open parse.  Since we only get here if  
                  * there does exist data (see tbl_data.c), we're  
                  * guaranteed that something's been allocated.  
                  * Do the same for ROFF_EQN.  
                  */  
   
                 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;  
                 }  
   
                 /* Temporary buffers typically are not full. */                  /* Temporary buffers typically are not full. */
   
                 if (0 == start && '\0' == blk.buf[i])                  if (0 == start && '\0' == blk.buf[i])
Line 379  rerun:
Line 572  rerun:
   
                 pos = 0;                  pos = 0;
         }          }
   out:
         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);  
   
         if (with_mmap)  
                 munmap(blk.buf, blk.sz);  
         else  
                 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, const char *file, int fd,
                   struct buf *fb, int *with_mmap)
 {  {
         struct stat      st;          struct stat      st;
           gzFile           gz;
         size_t           off;          size_t           off;
         ssize_t          ssz;          ssize_t          ssz;
           int              gzerrnum, retval;
   
         if (-1 == fstat(fd, &st)) {          if (fstat(fd, &st) == -1) {
                 perror(file);                  mandoc_vmsg(MANDOCERR_FILE, curp, 0, 0,
                 return(0);                      "fstat: %s", strerror(errno));
                   return 0;
         }          }
   
         /*          /*
Line 432  read_whole_file(const char *file, int fd, struct buf *
Line 602  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, curp, 0, 0, NULL);
                         return(0);                          return 0;
                 }                  }
                 *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 1;
         }          }
   
           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_vmsg(MANDOCERR_FILE, curp, 0, 0,
                               "dup: %s", strerror(errno));
                           return 0;
                   }
                   if ((gz = gzdopen(fd, "rb")) == NULL) {
                           mandoc_vmsg(MANDOCERR_FILE, curp, 0, 0,
                               "gzdopen: %s", strerror(errno));
                           close(fd);
                           return 0;
                   }
           } 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 452  read_whole_file(const char *file, int fd, struct buf *
Line 643  read_whole_file(const char *file, int fd, struct buf *
   
         *with_mmap = 0;          *with_mmap = 0;
         off = 0;          off = 0;
           retval = 0;
         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, curp,
                                       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 = 1;
                           break;
                 }                  }
                 if (ssz == -1) {                  if (ssz == -1) {
                         perror(file);                          if (curp->gzip)
                                   (void)gzerror(gz, &gzerrnum);
                           mandoc_vmsg(MANDOCERR_FILE, curp, 0, 0, "read: %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_vmsg(MANDOCERR_FILE, curp, 0, 0, "gzclose: %s",
         return(0);                      gzerrnum == Z_ERRNO ? strerror(errno) :
                       zError(gzerrnum));
           if (retval == 0) {
                   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->macroset == MACROSET_NONE)
         if (MANDOCLEVEL_FATAL <= curp->file_status)                  curp->man->macroset = MACROSET_MAN;
                 return;          if (curp->man->macroset == MACROSET_MDOC)
                   mdoc_endparse(curp->man);
         if (curp->mdoc && ! mdoc_endparse(curp->mdoc)) {          else
                 assert(MANDOCLEVEL_FATAL <= curp->file_status);                  man_endparse(curp->man);
                 return;  
         }  
   
         if (curp->man && ! man_endparse(curp->man)) {  
                 assert(MANDOCLEVEL_FATAL <= curp->file_status);  
                 return;  
         }  
   
 #if 0  
         /* FIXME: NOTE a parser may not have been assigned, yet. */  
   
         if ( ! (curp->man || curp->mdoc)) {  
                 /* FIXME: make into an mandoc.h error. */  
                 fprintf(stderr, "%s: Not a manual\n", curp->file);  
                 curp->file_status = MANDOCLEVEL_FATAL;  
                 goto cleanup;  
         }  
 #endif  
   
         roff_endparse(curp->roff);          roff_endparse(curp->roff);
 }  }
   
 static void  static void
 mparse_readfd_r(struct mparse *curp, int fd, const char *file, int re)  mparse_parse_buffer(struct mparse *curp, struct buf blk, const char *file)
 {  {
           struct buf      *svprimary;
         const char      *svfile;          const char      *svfile;
           size_t           offset;
           static int       recursion_depth;
   
         if (-1 == fd)          if (64 < recursion_depth) {
                 if (-1 == (fd = open(file, O_RDONLY, 0))) {                  mandoc_msg(MANDOCERR_ROFFLOOP, curp, curp->line, 0, NULL);
                         perror(file);                  return;
                         curp->file_status = MANDOCLEVEL_SYSERR;          }
                         return;  
                 }  
   
           /* Line number is per-file. */
         svfile = curp->file;          svfile = curp->file;
         curp->file = file;          curp->file = file;
           svprimary = curp->primary;
           curp->primary = &blk;
           curp->line = 1;
           recursion_depth++;
   
         pdesc(curp, file, fd);          /* Skip an UTF-8 byte order mark. */
           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;
   
         if (0 == re && MANDOCLEVEL_FATAL > curp->file_status)          mparse_buf_r(curp, blk, offset, 1);
   
           if (--recursion_depth == 0)
                 mparse_end(curp);                  mparse_end(curp);
   
         if (STDIN_FILENO != fd && -1 == close(fd))          curp->primary = svprimary;
                 perror(file);  
   
         curp->file = svfile;          curp->file = svfile;
 }  }
   
 enum mandoclevel  enum mandoclevel
   mparse_readmem(struct mparse *curp, void *buf, size_t len,
                   const char *file)
   {
           struct buf blk;
   
           blk.buf = buf;
           blk.sz = len;
   
           mparse_parse_buffer(curp, blk, file);
           return curp->file_status;
   }
   
   /*
    * 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)  mparse_readfd(struct mparse *curp, int fd, const char *file)
 {  {
           struct buf       blk;
           int              with_mmap;
           int              save_filenc;
   
         mparse_readfd_r(curp, fd, file, 0);          if (read_whole_file(curp, file, fd, &blk, &with_mmap)) {
         return(curp->file_status);                  save_filenc = curp->filenc;
                   curp->filenc = curp->options &
                       (MPARSE_UTF8 | MPARSE_LATIN1);
                   mparse_parse_buffer(curp, blk, file);
                   curp->filenc = save_filenc;
                   if (with_mmap)
                           munmap(blk.buf, blk.sz);
                   else
                           free(blk.buf);
           }
           return curp->file_status;
 }  }
   
   int
   mparse_open(struct mparse *curp, const char *file)
   {
           char             *cp;
           int               fd;
   
           curp->file = file;
           cp = strrchr(file, '.');
           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) {
                   mandoc_asprintf(&cp, "%s.gz", file);
                   fd = open(cp, O_RDONLY);
                   free(cp);
                   if (fd != -1) {
                           curp->gzip = 1;
                           return fd;
                   }
           }
   
           /* Neither worked, give up. */
   
           mandoc_msg(MANDOCERR_FILE, curp, 0, 0, strerror(errno));
           return -1;
   }
   
 struct mparse *  struct mparse *
 mparse_alloc(enum mparset inttype, enum mandoclevel wlevel, mandocmsg mmsg, void *arg)  mparse_alloc(int options, enum mandocerr mmin, mandocmsg mmsg,
       enum mandoc_os os_e, const char *os_s)
 {  {
         struct mparse   *curp;          struct mparse   *curp;
   
         curp = mandoc_calloc(1, sizeof(struct mparse));          curp = mandoc_calloc(1, sizeof(struct mparse));
   
         curp->wlevel = wlevel;          curp->options = options;
           curp->mmin = mmin;
         curp->mmsg = mmsg;          curp->mmsg = mmsg;
         curp->arg = arg;          curp->os_s = os_s;
         curp->inttype = inttype;  
   
         curp->roff = roff_alloc(&curp->regs, curp);          curp->roff = roff_alloc(curp, options);
         return(curp);          curp->man = roff_man_alloc(curp->roff, curp, curp->os_s,
                   curp->options & MPARSE_QUICK ? 1 : 0);
           if (curp->options & MPARSE_MDOC) {
                   curp->man->macroset = MACROSET_MDOC;
                   if (curp->man->mdocmac == NULL)
                           curp->man->mdocmac = roffhash_alloc(MDOC_Dd, MDOC_MAX);
           } else if (curp->options & MPARSE_MAN) {
                   curp->man->macroset = MACROSET_MAN;
                   if (curp->man->manmac == NULL)
                           curp->man->manmac = roffhash_alloc(MAN_TH, MAN_MAX);
           }
           curp->man->first->tok = TOKEN_NONE;
           curp->man->meta.os_e = os_e;
           return curp;
 }  }
   
 void  void
 mparse_reset(struct mparse *curp)  mparse_reset(struct mparse *curp)
 {  {
   
         memset(&curp->regs, 0, sizeof(struct regset));  
   
         roff_reset(curp->roff);          roff_reset(curp->roff);
           roff_man_reset(curp->man);
           free_buf_list(curp->secondary);
           curp->secondary = NULL;
   
         if (curp->mdoc)          free(curp->sodest);
                 mdoc_reset(curp->mdoc);          curp->sodest = NULL;
         if (curp->man)  
                 man_reset(curp->man);  
   
         curp->file_status = MANDOCLEVEL_OK;          curp->file_status = MANDOCLEVEL_OK;
         curp->mdoc = NULL;          curp->gzip = 0;
         curp->man = NULL;  
 }  }
   
 void  void
 mparse_free(struct mparse *curp)  mparse_free(struct mparse *curp)
 {  {
           roffhash_free(curp->man->mdocmac);
         if (curp->pmdoc)          roffhash_free(curp->man->manmac);
                 mdoc_free(curp->pmdoc);          roff_man_free(curp->man);
         if (curp->pman)          roff_free(curp->roff);
                 man_free(curp->pman);          free_buf_list(curp->secondary);
         if (curp->roff)          free(curp->sodest);
                 roff_free(curp->roff);  
   
         free(curp);          free(curp);
 }  }
   
 void  void
 mparse_result(struct mparse *curp, struct mdoc **mdoc, struct man **man)  mparse_result(struct mparse *curp, struct roff_man **man,
           char **sodest)
 {  {
   
         *mdoc = curp->mdoc;          if (sodest && NULL != (*sodest = curp->sodest)) {
         *man = curp->man;                  *man = NULL;
                   return;
           }
           if (man)
                   *man = curp->man;
 }  }
   
 void  void
   mparse_updaterc(struct mparse *curp, enum mandoclevel *rc)
   {
           if (curp->file_status > *rc)
                   *rc = curp->file_status;
   }
   
   void
 mandoc_vmsg(enum mandocerr t, struct mparse *m,  mandoc_vmsg(enum mandocerr t, struct mparse *m,
                 int ln, int pos, const char *fmt, ...)                  int ln, int pos, const char *fmt, ...)
 {  {
Line 608  mandoc_vmsg(enum mandocerr t, struct mparse *m,
Line 896  mandoc_vmsg(enum mandocerr t, struct mparse *m,
         va_list          ap;          va_list          ap;
   
         va_start(ap, fmt);          va_start(ap, fmt);
         vsnprintf(buf, sizeof(buf) - 1, fmt, ap);          (void)vsnprintf(buf, sizeof(buf), fmt, ap);
         va_end(ap);          va_end(ap);
   
         mandoc_msg(t, m, ln, pos, buf);          mandoc_msg(t, m, ln, pos, buf);
 }  }
   
 void  void
 mandoc_msg(enum mandocerr er, struct mparse *m,  mandoc_msg(enum mandocerr er, struct mparse *m,
                 int ln, int col, const char *msg)                  int ln, int col, const char *msg)
 {  {
         enum mandoclevel level;          enum mandoclevel level;
   
         level = MANDOCLEVEL_FATAL;          if (er < m->mmin && er != MANDOCERR_FILE)
                   return;
   
           level = MANDOCLEVEL_UNSUPP;
         while (er < mandoclimits[level])          while (er < mandoclimits[level])
                 level--;                  level--;
   
         if (level < m->wlevel)          if (m->mmsg)
                 return;                  (*m->mmsg)(er, level, m->file, ln, col, msg);
   
         (*m->mmsg)(er, level, m->file, ln, col, msg);  
   
         if (m->file_status < level)          if (m->file_status < level)
                 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_copy(const struct mparse *p)
   {
           struct buf      *buf;
   
           for (buf = p->secondary; buf != NULL; buf = buf->next)
                   puts(buf->buf);
 }  }
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.198
CVSweb