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

Diff for /mandoc/read.c between version 1.86 and 1.99

version 1.86, 2014/09/07 23:25:01 version 1.99, 2014/11/27 23:40:19
Line 45 
Line 45 
   
 #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 {
         struct man       *pman; /* persistent man parser */          struct man       *pman; /* persistent man parser */
         struct mdoc      *pmdoc; /* persistent mdoc parser */          struct mdoc      *pmdoc; /* persistent mdoc parser */
         struct man       *man; /* man parser */          struct man       *man; /* man parser */
         struct mdoc      *mdoc; /* mdoc parser */          struct mdoc      *mdoc; /* mdoc parser */
         struct roff      *roff; /* roff parser (!NULL) */          struct roff      *roff; /* roff parser (!NULL) */
           const struct mchars *mchars; /* character table */
         char             *sodest; /* filename pointed to by .so */          char             *sodest; /* filename pointed to by .so */
         const char       *file; /* filename of current input file */          const char       *file; /* filename of current input file */
         struct buf       *primary; /* buffer currently being parsed */          struct buf       *primary; /* buffer currently being parsed */
Line 65  struct mparse {
Line 61  struct mparse {
         enum mandoclevel  file_status; /* status of current parse */          enum mandoclevel  file_status; /* status of current parse */
         enum mandoclevel  wlevel; /* ignore messages below this */          enum mandoclevel  wlevel; /* ignore messages below this */
         int               options; /* parser options */          int               options; /* parser options */
           int               filenc; /* encoding of the current file */
         int               reparse_count; /* finite interp. stack */          int               reparse_count; /* finite interp. stack */
         int               line; /* line number in the file */          int               line; /* line number in the file */
           pid_t             child; /* the gunzip(1) process */
 };  };
   
 static  void      choose_parser(struct mparse *);  static  void      choose_parser(struct mparse *);
 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  void      mparse_buf_r(struct mparse *, struct buf, size_t, int);
 static  int       read_whole_file(struct mparse *, const char *, int,  static  int       read_whole_file(struct mparse *, const char *, int,
                                 struct buf *, int *);                                  struct buf *, int *);
 static  void      mparse_end(struct mparse *);  static  void      mparse_end(struct mparse *);
Line 117  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 115  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "sections out of conventional order",          "sections out of conventional order",
         "duplicate section title",          "duplicate section title",
         "unexpected section",          "unexpected section",
           "unusual Xr order",
           "unusual Xr punctuation",
         "AUTHORS section without An macro",          "AUTHORS section without An macro",
   
         /* related to macros and nesting */          /* related to macros and nesting */
Line 147  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 147  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "missing font type, using \\fR",          "missing font type, using \\fR",
         "unknown font type, using \\fR",          "unknown font type, using \\fR",
         "missing -std argument, adding it",          "missing -std argument, adding it",
           "missing eqn box, using \"\"",
   
         /* related to bad macro arguments */          /* related to bad macro arguments */
         "unterminated quoted argument",          "unterminated quoted argument",
Line 156  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 157  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "skipping duplicate list type",          "skipping duplicate list type",
         "skipping -width argument",          "skipping -width argument",
         "unknown AT&T UNIX version",          "unknown AT&T UNIX version",
           "comma in function argument",
           "parenthesis in function name",
         "invalid content in Rs block",          "invalid content in Rs block",
         "invalid Boolean argument",          "invalid Boolean argument",
         "unknown font, skipping request",          "unknown font, skipping request",
Line 175  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 178  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "equation scope open on exit",          "equation scope open on exit",
         "overlapping equation scopes",          "overlapping equation scopes",
         "unexpected end of equation",          "unexpected end of equation",
         "equation syntax error",  
   
         /* related to tables */          /* related to tables */
         "bad table syntax",          "bad table syntax",
Line 200  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 202  static const char * const mandocerrs[MANDOCERR_MAX] = 
         /* related to request and macro arguments */          /* related to request and macro arguments */
         "escaped character not allowed in a name",          "escaped character not allowed in a name",
         "argument count wrong",          "argument count wrong",
           "NOT IMPLEMENTED: Bd -file",
         "missing list type, using -item",          "missing list type, using -item",
         "missing manual name, using \"\"",          "missing manual name, using \"\"",
         "uname(3) system call failed, using UNKNOWN",          "uname(3) system call failed, using UNKNOWN",
Line 207  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 210  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "skipping request without numeric argument",          "skipping request without numeric argument",
         "skipping all arguments",          "skipping all arguments",
         "skipping excess arguments",          "skipping excess arguments",
           "divide by zero",
   
         "generic fatal error",          "generic fatal error",
   
         "input too large",          "input too large",
         "NOT IMPLEMENTED: Bd -file",  
         "NOT IMPLEMENTED: .so with absolute path or \"..\"",          "NOT IMPLEMENTED: .so with absolute path or \"..\"",
         ".so request failed",          ".so request failed",
   
Line 301  choose_parser(struct mparse *curp)
Line 304  choose_parser(struct mparse *curp)
 }  }
   
 /*  /*
  * 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 void
 mparse_buf_r(struct mparse *curp, struct buf blk, int start)  mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
 {  {
         const struct tbl_span   *span;          const struct tbl_span   *span;
         struct buf       ln;          struct buf       ln;
           size_t           pos; /* byte number in the ln buffer */
         enum rofferr     rr;          enum rofferr     rr;
         int              i, of, rc;          int              of, rc;
         int              pos; /* byte number in the ln buffer */  
         int              lnn; /* line number in the real file */          int              lnn; /* line number in the real file */
         unsigned char    c;          unsigned char    c;
   
         memset(&ln, 0, sizeof(struct buf));          memset(&ln, 0, sizeof(ln));
   
         lnn = curp->line;          lnn = curp->line;
         pos = 0;          pos = 0;
   
         for (i = 0; i < (int)blk.sz; ) {          while (i < 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 338  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 348  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 348  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 358  mparse_buf_r(struct mparse *curp, struct buf blk, int 
                         }                          }
   
                         /*                          /*
                          * Make sure we have space for at least                           * Make sure we have space for the worst
                          * one backslash and one other character                           * case of 11 bytes: "\\[u10ffff]\0"
                          * and the trailing NUL byte.  
                          */                           */
   
                         if (pos + 2 >= (int)ln.sz)                          if (pos + 11 > ln.sz)
                                 resize_buf(&ln, 256);                                  resize_buf(&ln, 256);
   
                         /*                          /*
                          * Warn about bogus characters.  If you're using                           * Encode 8-bit input.
                          * non-ASCII encoding, you're screwing your  
                          * readers.  Since I'd rather this not happen,  
                          * I'll be helpful and replace these characters  
                          * with "?", so we don't display gibberish.  
                          * Note to manual writers: use special characters.  
                          */                           */
   
                         c = (unsigned char) blk.buf[i];                          c = blk.buf[i];
                           if (c & 0x80) {
                                   if ( ! (curp->filenc && preconv_encode(
                                       &blk, &i, &ln, &pos, &curp->filenc))) {
                                           mandoc_vmsg(MANDOCERR_BADCHAR,
                                               curp, curp->line, pos,
                                               "0x%x", c);
                                           ln.buf[pos++] = '?';
                                           i++;
                                   }
                                   continue;
                           }
   
                         if ( ! (isascii(c) &&                          /*
                             (isgraph(c) || isblank(c)))) {                           * Exclude control characters.
                            */
   
                           if (c == 0x7f || (c < 0x20 && c != 0x09)) {
                                 mandoc_vmsg(MANDOCERR_BADCHAR, curp,                                  mandoc_vmsg(MANDOCERR_BADCHAR, curp,
                                     curp->line, pos, "0x%x", c);                                      curp->line, pos, "0x%x", c);
                                 i++;                                  i++;
Line 378  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 396  mparse_buf_r(struct mparse *curp, struct buf blk, int 
   
                         /* Trailing backslash = a plain char. */                          /* Trailing backslash = a plain char. */
   
                         if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {                          if (blk.buf[i] != '\\' || i + 1 == blk.sz) {
                                 ln.buf[pos++] = blk.buf[i++];                                  ln.buf[pos++] = blk.buf[i++];
                                 continue;                                  continue;
                         }                          }
Line 390  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 408  mparse_buf_r(struct mparse *curp, struct buf blk, int 
                          * skip that one as well.                           * skip that one as well.
                          */                           */
   
                         if ('\r' == blk.buf[i + 1] && i + 2 < (int)blk.sz &&                          if ('\r' == blk.buf[i + 1] && i + 2 < blk.sz &&
                             '\n' == blk.buf[i + 2])                              '\n' == blk.buf[i + 2])
                                 ++i;                                  ++i;
                         if ('\n' == blk.buf[i + 1]) {                          if ('\n' == blk.buf[i + 1]) {
Line 402  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 420  mparse_buf_r(struct mparse *curp, struct buf blk, int 
                         if ('"' == blk.buf[i + 1] || '#' == blk.buf[i + 1]) {                          if ('"' == blk.buf[i + 1] || '#' == blk.buf[i + 1]) {
                                 i += 2;                                  i += 2;
                                 /* Comment, skip to end of line */                                  /* Comment, skip to end of line */
                                 for (; i < (int)blk.sz; ++i) {                                  for (; i < blk.sz; ++i) {
                                         if ('\n' == blk.buf[i]) {                                          if ('\n' == blk.buf[i]) {
                                                 ++i;                                                  ++i;
                                                 ++lnn;                                                  ++lnn;
Line 439  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 457  mparse_buf_r(struct mparse *curp, struct buf blk, int 
                         ln.buf[pos++] = blk.buf[i++];                          ln.buf[pos++] = blk.buf[i++];
                 }                  }
   
                 if (pos >= (int)ln.sz)                  if (pos >= ln.sz)
                         resize_buf(&ln, 256);                          resize_buf(&ln, 256);
   
                 ln.buf[pos] = '\0';                  ln.buf[pos] = '\0';
Line 476  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 494  mparse_buf_r(struct mparse *curp, struct buf blk, int 
                                 [curp->secondary->sz] = '\0';                                  [curp->secondary->sz] = '\0';
                 }                  }
 rerun:  rerun:
                 rr = roff_parseln(curp->roff, curp->line,                  rr = roff_parseln(curp->roff, curp->line, &ln, &of);
                     &ln.buf, &ln.sz, of, &of);  
   
                 switch (rr) {                  switch (rr) {
                 case ROFF_REPARSE:                  case ROFF_REPARSE:
                         if (REPARSE_LIMIT >= ++curp->reparse_count)                          if (REPARSE_LIMIT >= ++curp->reparse_count)
                                 mparse_buf_r(curp, ln, 0);                                  mparse_buf_r(curp, ln, of, 0);
                         else                          else
                                 mandoc_msg(MANDOCERR_ROFFLOOP, curp,                                  mandoc_msg(MANDOCERR_ROFFLOOP, curp,
                                     curp->line, pos, NULL);                                      curp->line, pos, NULL);
                         pos = 0;                          pos = 0;
                         continue;                          continue;
                 case ROFF_APPEND:                  case ROFF_APPEND:
                         pos = (int)strlen(ln.buf);                          pos = strlen(ln.buf);
                         continue;                          continue;
                 case ROFF_RERUN:                  case ROFF_RERUN:
                         goto rerun;                          goto rerun;
Line 500  rerun:
Line 517  rerun:
                         assert(MANDOCLEVEL_FATAL <= curp->file_status);                          assert(MANDOCLEVEL_FATAL <= curp->file_status);
                         break;                          break;
                 case ROFF_SO:                  case ROFF_SO:
                         if (0 == (MPARSE_SO & curp->options) &&                          if ( ! (curp->options & MPARSE_SO) &&
                             (i >= (int)blk.sz || '\0' == blk.buf[i])) {                              (i >= blk.sz || blk.buf[i] == '\0')) {
                                 curp->sodest = mandoc_strdup(ln.buf + of);                                  curp->sodest = mandoc_strdup(ln.buf + of);
                                 free(ln.buf);                                  free(ln.buf);
                                 return;                                  return;
Line 715  mparse_parse_buffer(struct mparse *curp, struct buf bl
Line 732  mparse_parse_buffer(struct mparse *curp, struct buf bl
 {  {
         struct buf      *svprimary;          struct buf      *svprimary;
         const char      *svfile;          const char      *svfile;
           size_t           offset;
         static int       recursion_depth;          static int       recursion_depth;
   
         if (64 < recursion_depth) {          if (64 < recursion_depth) {
Line 730  mparse_parse_buffer(struct mparse *curp, struct buf bl
Line 748  mparse_parse_buffer(struct mparse *curp, struct buf bl
         curp->line = 1;          curp->line = 1;
         recursion_depth++;          recursion_depth++;
   
         mparse_buf_r(curp, blk, 1);          /* 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;
   
           mparse_buf_r(curp, blk, offset, 1);
   
         if (0 == --recursion_depth && MANDOCLEVEL_FATAL > curp->file_status)          if (0 == --recursion_depth && MANDOCLEVEL_FATAL > curp->file_status)
                 mparse_end(curp);                  mparse_end(curp);
   
Line 752  mparse_readmem(struct mparse *curp, const void *buf, s
Line 780  mparse_readmem(struct mparse *curp, const void *buf, s
         return(curp->file_status);          return(curp->file_status);
 }  }
   
   /*
    * If a file descriptor is given, use it and assume it points
    * to the named file.  Otherwise, open the named file.
    * Read the whole file into memory and call the parsers.
    * Called recursively when an .so request is encountered.
    */
 enum mandoclevel  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;          struct buf       blk;
         int              with_mmap;          int              with_mmap;
           int              save_filenc;
           pid_t            save_child;
   
         if (-1 == fd && -1 == (fd = open(file, O_RDONLY, 0))) {          save_child = curp->child;
                 curp->file_status = MANDOCLEVEL_SYSERR;          if (fd != -1)
                 if (curp->mmsg)                  curp->child = 0;
                         (*curp->mmsg)(MANDOCERR_SYSOPEN,          else if (mparse_open(curp, &fd, file) >= MANDOCLEVEL_SYSERR)
                             curp->file_status,  
                             file, 0, 0, strerror(errno));  
                 goto out;                  goto out;
         }  
   
         /*          if (read_whole_file(curp, file, fd, &blk, &with_mmap)) {
          * Run for each opened file; may be called more than once for                  save_filenc = curp->filenc;
          * each full parse sequence if the opened file is nested (i.e.,                  curp->filenc = curp->options &
          * from `so').  Simply sucks in the whole file and moves into                      (MPARSE_UTF8 | MPARSE_LATIN1);
          * the parse phase for the file.                  mparse_parse_buffer(curp, blk, file);
          */                  curp->filenc = save_filenc;
   
         if ( ! read_whole_file(curp, file, fd, &blk, &with_mmap))  
                 goto out;  
   
         mparse_parse_buffer(curp, blk, file);  
   
 #if HAVE_MMAP  #if HAVE_MMAP
         if (with_mmap)                  if (with_mmap)
                 munmap(blk.buf, blk.sz);                          munmap(blk.buf, blk.sz);
         else                  else
 #endif  #endif
                 free(blk.buf);                          free(blk.buf);
           }
   
         if (STDIN_FILENO != fd && -1 == close(fd))          if (fd != STDIN_FILENO && close(fd) == -1)
                 perror(file);                  perror(file);
   
           mparse_wait(curp);
 out:  out:
           curp->child = save_child;
         return(curp->file_status);          return(curp->file_status);
 }  }
   
 enum mandoclevel  enum mandoclevel
 mparse_open(struct mparse *curp, int *fd, const char *file,  mparse_open(struct mparse *curp, int *fd, const char *file)
         pid_t *child_pid)  
 {  {
         int               pfd[2];          int               pfd[2];
           int               save_errno;
         char             *cp;          char             *cp;
         enum mandocerr    err;          enum mandocerr    err;
   
         pfd[1] = -1;          pfd[1] = -1;
         curp->file = file;          curp->file = file;
   
           /* Unless zipped, try to just open the file. */
   
         if ((cp = strrchr(file, '.')) == NULL ||          if ((cp = strrchr(file, '.')) == NULL ||
             strcmp(cp + 1, "gz")) {              strcmp(cp + 1, "gz")) {
                 *child_pid = 0;                  curp->child = 0;
                 if ((*fd = open(file, O_RDONLY)) == -1) {                  if ((*fd = open(file, O_RDONLY)) != -1)
                         err = MANDOCERR_SYSOPEN;                          return(MANDOCLEVEL_OK);
                         goto out;  
                 }                  /* Open failed; try to append ".gz". */
                 return(MANDOCLEVEL_OK);  
                   mandoc_asprintf(&cp, "%s.gz", file);
                   file = cp;
           } else
                   cp = NULL;
   
           /* Before forking, make sure the file can be read. */
   
           save_errno = errno;
           if (access(file, R_OK) == -1) {
                   if (cp != NULL)
                           errno = save_errno;
                   err = MANDOCERR_SYSOPEN;
                   goto out;
         }          }
   
           /* Run gunzip(1). */
   
         if (pipe(pfd) == -1) {          if (pipe(pfd) == -1) {
                 err = MANDOCERR_SYSPIPE;                  err = MANDOCERR_SYSPIPE;
                 goto out;                  goto out;
         }          }
   
         switch (*child_pid = fork()) {          switch (curp->child = fork()) {
         case -1:          case -1:
                 err = MANDOCERR_SYSFORK;                  err = MANDOCERR_SYSFORK;
                 close(pfd[0]);                  close(pfd[0]);
Line 840  mparse_open(struct mparse *curp, int *fd, const char *
Line 889  mparse_open(struct mparse *curp, int *fd, const char *
         }          }
   
 out:  out:
           free(cp);
         *fd = -1;          *fd = -1;
         *child_pid = 0;          curp->child = 0;
         curp->file_status = MANDOCLEVEL_SYSERR;          curp->file_status = MANDOCLEVEL_SYSERR;
         if (curp->mmsg)          if (curp->mmsg)
                 (*curp->mmsg)(err, curp->file_status, file,                  (*curp->mmsg)(err, curp->file_status, curp->file,
                     0, 0, strerror(errno));                      0, 0, strerror(errno));
         if (pfd[1] != -1)          if (pfd[1] != -1)
                 exit(1);                  exit(1);
Line 852  out:
Line 902  out:
 }  }
   
 enum mandoclevel  enum mandoclevel
 mparse_wait(struct mparse *curp, pid_t child_pid)  mparse_wait(struct mparse *curp)
 {  {
         int       status;          int       status;
   
         if (waitpid(child_pid, &status, 0) == -1) {          if (curp->child == 0)
                   return(MANDOCLEVEL_OK);
   
           if (waitpid(curp->child, &status, 0) == -1) {
                 mandoc_msg(MANDOCERR_SYSWAIT, curp, 0, 0,                  mandoc_msg(MANDOCERR_SYSWAIT, curp, 0, 0,
                     strerror(errno));                      strerror(errno));
                 curp->file_status = MANDOCLEVEL_SYSERR;                  curp->file_status = MANDOCLEVEL_SYSERR;
Line 878  mparse_wait(struct mparse *curp, pid_t child_pid)
Line 931  mparse_wait(struct mparse *curp, pid_t child_pid)
 }  }
   
 struct mparse *  struct mparse *
 mparse_alloc(int options, enum mandoclevel wlevel,  mparse_alloc(int options, enum mandoclevel wlevel, mandocmsg mmsg,
                 mandocmsg mmsg, const char *defos)      const struct mchars *mchars, const char *defos)
 {  {
         struct mparse   *curp;          struct mparse   *curp;
   
Line 892  mparse_alloc(int options, enum mandoclevel wlevel,
Line 945  mparse_alloc(int options, enum mandoclevel wlevel,
         curp->mmsg = mmsg;          curp->mmsg = mmsg;
         curp->defos = defos;          curp->defos = defos;
   
         curp->roff = roff_alloc(curp, options);          curp->mchars = mchars;
           curp->roff = roff_alloc(curp, curp->mchars, options);
         if (curp->options & MPARSE_MDOC)          if (curp->options & MPARSE_MDOC)
                 curp->pmdoc = mdoc_alloc(                  curp->pmdoc = mdoc_alloc(
                     curp->roff, curp, curp->defos,                      curp->roff, curp, curp->defos,
Legend:
Removed from v.1.86  
changed lines
  Added in v.1.99
CVSweb