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

Diff for /mandoc/read.c between version 1.154 and 1.180

version 1.154, 2016/12/07 22:59:29 version 1.180, 2017/06/24 15:59:50
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-2016 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2010, 2012 Joerg Sonnenberger <joerg@netbsd.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
Line 30 
Line 30 
 #include <errno.h>  #include <errno.h>
 #include <fcntl.h>  #include <fcntl.h>
 #include <stdarg.h>  #include <stdarg.h>
 #include <stdint.h>  
 #include <stdio.h>  #include <stdio.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
Line 48 
Line 47 
 #define REPARSE_LIMIT   1000  #define REPARSE_LIMIT   1000
   
 struct  mparse {  struct  mparse {
         struct roff_man  *man; /* man parser */  
         struct roff      *roff; /* roff parser (!NULL) */          struct roff      *roff; /* roff parser (!NULL) */
           struct roff_man  *man; /* man parser */
         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 */
         struct buf       *secondary; /* preprocessed copy of input */          struct buf       *secondary; /* preprocessed copy of input */
         const char       *defos; /* default operating system */          const char       *os_s; /* default operating system */
         mandocmsg         mmsg; /* warning/error message handler */          mandocmsg         mmsg; /* warning/error message handler */
         enum mandoclevel  file_status; /* status of current parse */          enum mandoclevel  file_status; /* status of current parse */
         enum mandoclevel  wlevel; /* ignore messages below this */          enum mandocerr    mmin; /* ignore messages below this */
         int               options; /* parser options */          int               options; /* parser options */
         int               gzip; /* current input file is gzipped */          int               gzip; /* current input file is gzipped */
         int               filenc; /* encoding of the current file */          int               filenc; /* encoding of the current file */
Line 67  struct mparse {
Line 66  struct mparse {
   
 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, size_t, int);  static  int       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 76  static void   mparse_parse_buffer(struct mparse *, str
Line 75  static void   mparse_parse_buffer(struct mparse *, str
   
 static  const enum mandocerr    mandoclimits[MANDOCLEVEL_MAX] = {  static  const enum mandocerr    mandoclimits[MANDOCLEVEL_MAX] = {
         MANDOCERR_OK,          MANDOCERR_OK,
           MANDOCERR_STYLE,
         MANDOCERR_WARNING,          MANDOCERR_WARNING,
         MANDOCERR_WARNING,  
         MANDOCERR_ERROR,          MANDOCERR_ERROR,
         MANDOCERR_UNSUPP,          MANDOCERR_UNSUPP,
         MANDOCERR_MAX,          MANDOCERR_MAX,
Line 87  static const enum mandocerr mandoclimits[MANDOCLEVEL_M
Line 86  static const enum mandocerr mandoclimits[MANDOCLEVEL_M
 static  const char * const      mandocerrs[MANDOCERR_MAX] = {  static  const char * const      mandocerrs[MANDOCERR_MAX] = {
         "ok",          "ok",
   
           "base system convention",
   
           "Mdocdate found",
           "Mdocdate missing",
           "operating system explicitly specified",
           "RCS id missing",
   
           "generic style suggestion",
   
           "legacy man(7) date format",
           "duplicate RCS id",
           "useless macro",
           "consider using OS macro",
           "errnos out of order",
           "duplicate errno",
           "description line ends with a full stop",
           "no blank before trailing delimiter",
           "function name without markup",
   
         "generic warning",          "generic warning",
   
         /* related to the prologue */          /* related to the prologue */
Line 108  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 126  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "no document body",          "no document body",
         "content before first section header",          "content before first section header",
         "first section is not \"NAME\"",          "first section is not \"NAME\"",
         "NAME section without name",          "NAME section without Nm before Nd",
         "NAME section without description",          "NAME section without description",
         "description not at the end of NAME",          "description not at the end of NAME",
         "bad NAME section content",          "bad NAME section content",
           "missing comma before name",
         "missing description line, using \"\"",          "missing description line, using \"\"",
           "description line outside NAME section",
         "sections out of conventional order",          "sections out of conventional order",
         "duplicate section title",          "duplicate section title",
         "unexpected section",          "unexpected section",
Line 132  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 152  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "fill mode already enabled, skipping",          "fill mode already enabled, skipping",
         "fill mode already disabled, skipping",          "fill mode already disabled, skipping",
         "line scope broken",          "line scope broken",
           "skipping blank line in line scope",
   
         /* related to missing macro arguments */          /* related to missing macro arguments */
         "skipping empty request",          "skipping empty request",
Line 150  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 171  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "unknown font type, using \\fR",          "unknown font type, using \\fR",
         "nothing follows prefix",          "nothing follows prefix",
         "empty reference block",          "empty reference block",
           "missing section argument",
         "missing -std argument, adding it",          "missing -std argument, adding it",
         "missing option string, using \"\"",          "missing option string, using \"\"",
         "missing resource identifier, using \"\"",          "missing resource identifier, using \"\"",
Line 166  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 188  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "unknown AT&T UNIX version",          "unknown AT&T UNIX version",
         "comma in function argument",          "comma in function argument",
         "parenthesis in function name",          "parenthesis in function name",
           "unknown library 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 198  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "blank line in fill mode, using .sp",          "blank line in fill mode, using .sp",
         "tab in filled text",          "tab in filled text",
         "whitespace at end of input line",          "whitespace at end of input line",
           "new sentence, new line",
         "bad comment style",          "bad comment style",
         "invalid escape sequence",          "invalid escape sequence",
         "undefined string, using \"\"",          "undefined string, using \"\"",
Line 217  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 241  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "NOT IMPLEMENTED: Bd -file",          "NOT IMPLEMENTED: Bd -file",
         "skipping display without arguments",          "skipping display without arguments",
         "missing list type, using -item",          "missing list type, using -item",
           "argument is not numeric, using 1",
         "missing manual name, using \"\"",          "missing manual name, using \"\"",
         "uname(3) system call failed, using UNKNOWN",          "uname(3) system call failed, using UNKNOWN",
         "unknown standard specifier",          "unknown standard specifier",
Line 238  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 263  static const char * const mandocerrs[MANDOCERR_MAX] = 
   
 static  const char * const      mandoclevels[MANDOCLEVEL_MAX] = {  static  const char * const      mandoclevels[MANDOCLEVEL_MAX] = {
         "SUCCESS",          "SUCCESS",
         "RESERVED",          "STYLE",
         "WARNING",          "WARNING",
         "ERROR",          "ERROR",
         "UNSUPP",          "UNSUPP",
Line 290  choose_parser(struct mparse *curp)
Line 315  choose_parser(struct mparse *curp)
         }          }
   
         if (format == MPARSE_MDOC) {          if (format == MPARSE_MDOC) {
                 mdoc_hash_init();  
                 curp->man->macroset = MACROSET_MDOC;                  curp->man->macroset = MACROSET_MDOC;
                 curp->man->first->tok = TOKEN_NONE;                  if (curp->man->mdocmac == NULL)
                           curp->man->mdocmac = roffhash_alloc(MDOC_Dd, MDOC_MAX);
         } else {          } else {
                 man_hash_init();  
                 curp->man->macroset = MACROSET_MAN;                  curp->man->macroset = MACROSET_MAN;
                 curp->man->first->tok = TOKEN_NONE;                  if (curp->man->manmac == NULL)
                           curp->man->manmac = roffhash_alloc(MAN_TH, MAN_MAX);
         }          }
           curp->man->first->tok = TOKEN_NONE;
 }  }
   
 /*  /*
Line 307  choose_parser(struct mparse *curp)
Line 333  choose_parser(struct mparse *curp)
  * macros, inline equations, and input line traps)   * macros, inline equations, and input line traps)
  * and indirectly (for .so file inclusion).   * and indirectly (for .so file inclusion).
  */   */
 static void  static int
 mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, 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;
Line 315  mparse_buf_r(struct mparse *curp, struct buf blk, size
Line 341  mparse_buf_r(struct mparse *curp, struct buf blk, size
         const char      *save_file;          const char      *save_file;
         char            *cp;          char            *cp;
         size_t           pos; /* byte number in the ln buffer */          size_t           pos; /* byte number in the ln buffer */
         size_t           j;  /* auxiliary byte number in the blk buffer */  
         enum rofferr     rr;          enum rofferr     rr;
         int              of;          int              of;
         int              lnn; /* line number in the real file */          int              lnn; /* line number in the real file */
Line 397  mparse_buf_r(struct mparse *curp, struct buf blk, size
Line 422  mparse_buf_r(struct mparse *curp, struct buf blk, size
                                 continue;                                  continue;
                         }                          }
   
                         /* Trailing backslash = a plain char. */  
   
                         if (blk.buf[i] != '\\' || i + 1 == blk.sz) {  
                                 ln.buf[pos++] = blk.buf[i++];  
                                 continue;  
                         }  
   
                         /*  
                          * Found escape and at least one other character.  
                          * 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 < blk.sz &&  
                             '\n' == blk.buf[i + 2])  
                                 ++i;  
                         if ('\n' == blk.buf[i + 1]) {  
                                 i += 2;  
                                 ++lnn;  
                                 continue;  
                         }  
   
                         if ('"' == blk.buf[i + 1] || '#' == blk.buf[i + 1]) {  
                                 j = i;  
                                 i += 2;  
                                 /* Comment, skip to end of line */  
                                 for (; i < blk.sz; ++i) {  
                                         if (blk.buf[i] != '\n')  
                                                 continue;  
                                         if (blk.buf[i - 1] == ' ' ||  
                                             blk.buf[i - 1] == '\t')  
                                                 mandoc_msg(  
                                                     MANDOCERR_SPACE_EOL,  
                                                     curp, curp->line,  
                                                     pos + i-1 - j, NULL);  
                                         ++i;  
                                         ++lnn;  
                                         break;  
                                 }  
   
                                 /* Backout trailing whitespaces */  
                                 for (; pos > 0; --pos) {  
                                         if (ln.buf[pos - 1] != ' ')  
                                                 break;  
                                         if (pos > 2 && ln.buf[pos - 2] == '\\')  
                                                 break;  
                                 }  
                                 break;  
                         }  
   
                         /* Catch escaped bogus characters. */  
   
                         c = (unsigned char) blk.buf[i+1];  
   
                         if ( ! (isascii(c) &&  
                             (isgraph(c) || isblank(c)))) {  
                                 mandoc_vmsg(MANDOCERR_CHAR_BAD, curp,  
                                     curp->line, pos, "0x%x", c);  
                                 i += 2;  
                                 ln.buf[pos++] = '?';  
                                 continue;  
                         }  
   
                         /* Some other escape sequence, copy & cont. */  
   
                         ln.buf[pos++] = blk.buf[i++];                          ln.buf[pos++] = blk.buf[i++];
                         ln.buf[pos++] = blk.buf[i++];  
                 }                  }
   
                 if (pos >= ln.sz)                  if (pos + 1 >= ln.sz)
                         resize_buf(&ln, 256);                          resize_buf(&ln, 256);
   
                   if (i == blk.sz || blk.buf[i] == '\0')
                           ln.buf[pos++] = '\n';
                 ln.buf[pos] = '\0';                  ln.buf[pos] = '\0';
   
                 /*                  /*
Line 508  rerun:
Line 468  rerun:
   
                 switch (rr) {                  switch (rr) {
                 case ROFF_REPARSE:                  case ROFF_REPARSE:
                         if (REPARSE_LIMIT >= ++curp->reparse_count)                          if (++curp->reparse_count > REPARSE_LIMIT)
                                 mparse_buf_r(curp, ln, of, 0);  
                         else  
                                 mandoc_msg(MANDOCERR_ROFFLOOP, curp,                                  mandoc_msg(MANDOCERR_ROFFLOOP, curp,
                                     curp->line, pos, NULL);                                      curp->line, pos, NULL);
                         pos = 0;                          else if (mparse_buf_r(curp, ln, of, 0) == 1 ||
                         continue;                              start == 1) {
                                   pos = 0;
                                   continue;
                           }
                           free(ln.buf);
                           return 0;
                 case ROFF_APPEND:                  case ROFF_APPEND:
                         pos = strlen(ln.buf);                          pos = strlen(ln.buf);
                         continue;                          continue;
Line 528  rerun:
Line 491  rerun:
                             (i >= blk.sz || blk.buf[i] == '\0')) {                              (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 1;
                         }                          }
                         /*                          /*
                          * We remove `so' clauses from our lookaside                           * We remove `so' clauses from our lookaside
Line 594  rerun:
Line 557  rerun:
         }          }
   
         free(ln.buf);          free(ln.buf);
           return 1;
 }  }
   
 static int  static int
 read_whole_file(struct mparse *curp, const char *file, int fd,  read_whole_file(struct mparse *curp, const char *file, int fd,
                 struct buf *fb, int *with_mmap)                  struct buf *fb, int *with_mmap)
 {  {
           struct stat      st;
         gzFile           gz;          gzFile           gz;
         size_t           off;          size_t           off;
         ssize_t          ssz;          ssize_t          ssz;
   
         struct stat      st;  
   
         if (fstat(fd, &st) == -1)          if (fstat(fd, &st) == -1)
                 err((int)MANDOCLEVEL_SYSERR, "%s", file);                  err((int)MANDOCLEVEL_SYSERR, "%s", file);
   
Line 796  mparse_open(struct mparse *curp, const char *file)
Line 759  mparse_open(struct mparse *curp, const char *file)
 }  }
   
 struct mparse *  struct mparse *
 mparse_alloc(int options, enum mandoclevel wlevel, mandocmsg mmsg,  mparse_alloc(int options, enum mandocerr mmin, mandocmsg mmsg,
     const char *defos)      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->options = options;          curp->options = options;
         curp->wlevel = wlevel;          curp->mmin = mmin;
         curp->mmsg = mmsg;          curp->mmsg = mmsg;
         curp->defos = defos;          curp->os_s = os_s;
   
         curp->roff = roff_alloc(curp, options);          curp->roff = roff_alloc(curp, options);
         curp->man = roff_man_alloc( curp->roff, curp, curp->defos,          curp->man = roff_man_alloc(curp->roff, curp, curp->os_s,
                 curp->options & MPARSE_QUICK ? 1 : 0);                  curp->options & MPARSE_QUICK ? 1 : 0);
         if (curp->options & MPARSE_MDOC) {          if (curp->options & MPARSE_MDOC) {
                 mdoc_hash_init();  
                 curp->man->macroset = MACROSET_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) {          } else if (curp->options & MPARSE_MAN) {
                 man_hash_init();  
                 curp->man->macroset = MACROSET_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->first->tok = TOKEN_NONE;
           curp->man->meta.os_e = os_e;
         return curp;          return curp;
 }  }
   
Line 827  mparse_reset(struct mparse *curp)
Line 793  mparse_reset(struct mparse *curp)
 {  {
         roff_reset(curp->roff);          roff_reset(curp->roff);
         roff_man_reset(curp->man);          roff_man_reset(curp->man);
   
           free(curp->sodest);
           curp->sodest = NULL;
   
         if (curp->secondary)          if (curp->secondary)
                 curp->secondary->sz = 0;                  curp->secondary->sz = 0;
   
         curp->file_status = MANDOCLEVEL_OK;          curp->file_status = MANDOCLEVEL_OK;
           curp->gzip = 0;
         free(curp->sodest);  
         curp->sodest = NULL;  
 }  }
   
 void  void
 mparse_free(struct mparse *curp)  mparse_free(struct mparse *curp)
 {  {
   
           roffhash_free(curp->man->mdocmac);
           roffhash_free(curp->man->manmac);
         roff_man_free(curp->man);          roff_man_free(curp->man);
         if (curp->roff)          roff_free(curp->roff);
                 roff_free(curp->roff);  
         if (curp->secondary)          if (curp->secondary)
                 free(curp->secondary->buf);                  free(curp->secondary->buf);
   
Line 865  mparse_result(struct mparse *curp, struct roff_man **m
Line 834  mparse_result(struct mparse *curp, struct roff_man **m
 }  }
   
 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 884  mandoc_msg(enum mandocerr er, struct mparse *m,
Line 860  mandoc_msg(enum mandocerr er, struct mparse *m,
 {  {
         enum mandoclevel level;          enum mandoclevel level;
   
           if (er < m->mmin && er != MANDOCERR_FILE)
                   return;
   
         level = MANDOCLEVEL_UNSUPP;          level = MANDOCLEVEL_UNSUPP;
         while (er < mandoclimits[level])          while (er < mandoclimits[level])
                 level--;                  level--;
   
         if (level < m->wlevel && er != MANDOCERR_FILE)  
                 return;  
   
         if (m->mmsg)          if (m->mmsg)
                 (*m->mmsg)(er, level, m->file, ln, col, msg);                  (*m->mmsg)(er, level, m->file, ln, col, msg);
Legend:
Removed from v.1.154  
changed lines
  Added in v.1.180
CVSweb