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

Diff for /mandoc/read.c between version 1.19 and 1.38

version 1.19, 2011/07/18 14:30:51 version 1.38, 2013/07/13 12:52:07
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, 2011, 2012, 2013 Ingo Schwarze <schwarze@openbsd.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
Line 28 
Line 28 
 #include <ctype.h>  #include <ctype.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 37 
Line 38 
 #include "libmandoc.h"  #include "libmandoc.h"
 #include "mdoc.h"  #include "mdoc.h"
 #include "man.h"  #include "man.h"
   #include "main.h"
   
 #ifndef MAP_FILE  
 #define MAP_FILE        0  
 #endif  
   
 #define REPARSE_LIMIT   1000  #define REPARSE_LIMIT   1000
   
 struct  buf {  struct  buf {
Line 63  struct mparse {
Line 61  struct mparse {
         mandocmsg         mmsg; /* warning/error message handler */          mandocmsg         mmsg; /* warning/error message handler */
         void             *arg; /* argument to mmsg */          void             *arg; /* argument to mmsg */
         const char       *file;          const char       *file;
           struct buf       *secondary;
           char             *defos; /* default operating system */
 };  };
   
 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, int);
 static  void      mparse_readfd_r(struct mparse *, int, const char *, int);  
 static  void      pset(const char *, int, struct mparse *);  static  void      pset(const char *, int, struct mparse *);
 static  void      pdesc(struct mparse *, const char *, int);  
 static  int       read_whole_file(const char *, int, struct buf *, int *);  static  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,
Line 92  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 92  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "no title in document",          "no title in document",
         "document title should be all caps",          "document title should be all caps",
         "unknown manual section",          "unknown manual section",
           "unknown manual volume or arch",
         "date missing, using today's date",          "date missing, using today's date",
         "cannot parse date, using it verbatim",          "cannot parse date, using it verbatim",
         "prologue macros out of order",          "prologue macros out of order",
Line 103  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 104  static const char * const mandocerrs[MANDOCERR_MAX] = 
         ".so is fragile, better use ln(1)",          ".so is fragile, better use ln(1)",
         "NAME section must come first",          "NAME section must come first",
         "bad NAME section contents",          "bad NAME section contents",
         "manual name not yet set",  
         "sections out of conventional order",          "sections out of conventional order",
         "duplicate section name",          "duplicate section name",
         "section not in conventional manual section",          "section not in conventional manual section",
Line 111  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 111  static const char * const mandocerrs[MANDOCERR_MAX] = 
         /* related to macros and nesting */          /* related to macros and nesting */
         "skipping obsolete macro",          "skipping obsolete macro",
         "skipping paragraph macro",          "skipping paragraph macro",
           "moving paragraph macro out of list",
         "skipping no-space macro",          "skipping no-space macro",
         "blocks badly nested",          "blocks badly nested",
         "child violates parent syntax",          "child violates parent syntax",
Line 152  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 153  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "generic error",          "generic error",
   
         /* related to equations */          /* related to equations */
         "bad equation macro syntax",          "unexpected equation scope closure",
         "too many nested equation defines",          "equation scope open on exit",
           "overlapping equation scopes",
           "unexpected end of equation",
           "equation syntax error",
   
         /* related to tables */          /* related to tables */
         "bad table syntax",          "bad table syntax",
Line 168  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 172  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "input stack limit exceeded, infinite loop?",          "input stack limit exceeded, infinite loop?",
         "skipping bad character",          "skipping bad character",
         "escaped character not allowed in a name",          "escaped character not allowed in a name",
           "manual name not yet set",
         "skipping text before the first section header",          "skipping text before the first section header",
         "skipping unknown macro",          "skipping unknown macro",
         "NOT IMPLEMENTED, please use groff: skipping request",          "NOT IMPLEMENTED, please use groff: skipping request",
         "argument count wrong",          "argument count wrong",
           "skipping column outside column list",
         "skipping end of block that is not open",          "skipping end of block that is not open",
         "missing end of block",          "missing end of block",
         "scope open on exit",          "scope open on exit",
Line 179  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 185  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "macro requires line argument(s)",          "macro requires line argument(s)",
         "macro requires body argument(s)",          "macro requires body argument(s)",
         "macro requires argument(s)",          "macro requires argument(s)",
           "request requires a numeric argument",
         "missing list type",          "missing list type",
         "line argument(s) will be lost",          "line argument(s) will be lost",
         "body argument(s) will be lost",          "body argument(s) will be lost",
Line 188  static const char * const mandocerrs[MANDOCERR_MAX] = 
Line 195  static const char * const mandocerrs[MANDOCERR_MAX] = 
         "not a manual",          "not a manual",
         "column syntax is inconsistent",          "column syntax is inconsistent",
         "NOT IMPLEMENTED: .Bd -file",          "NOT IMPLEMENTED: .Bd -file",
         "line scope broken, syntax violated",  
         "argument count wrong, violates syntax",          "argument count wrong, violates syntax",
         "child violates parent syntax",          "child violates parent syntax",
         "argument count wrong, violates syntax",          "argument count wrong, violates syntax",
Line 243  pset(const char *buf, int pos, struct mparse *curp)
Line 249  pset(const char *buf, int pos, struct mparse *curp)
         switch (curp->inttype) {          switch (curp->inttype) {
         case (MPARSE_MDOC):          case (MPARSE_MDOC):
                 if (NULL == curp->pmdoc)                  if (NULL == curp->pmdoc)
                         curp->pmdoc = mdoc_alloc(curp->roff, curp);                          curp->pmdoc = mdoc_alloc(curp->roff, curp,
                                           curp->defos);
                 assert(curp->pmdoc);                  assert(curp->pmdoc);
                 curp->mdoc = curp->pmdoc;                  curp->mdoc = curp->pmdoc;
                 return;                  return;
Line 259  pset(const char *buf, int pos, struct mparse *curp)
Line 266  pset(const char *buf, int pos, struct mparse *curp)
   
         if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3))  {          if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3))  {
                 if (NULL == curp->pmdoc)                  if (NULL == curp->pmdoc)
                         curp->pmdoc = mdoc_alloc(curp->roff, curp);                          curp->pmdoc = mdoc_alloc(curp->roff, curp,
                                           curp->defos);
                 assert(curp->pmdoc);                  assert(curp->pmdoc);
                 curp->mdoc = curp->pmdoc;                  curp->mdoc = curp->pmdoc;
                 return;                  return;
Line 318  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 326  mparse_buf_r(struct mparse *curp, struct buf blk, int 
                                 break;                                  break;
                         }                          }
   
                           /*
                            * Make sure we have space for at least
                            * one backslash and one other character
                            * and the trailing NUL byte.
                            */
   
                           if (pos + 2 >= (int)ln.sz)
                                   resize_buf(&ln, 256);
   
                         /*                          /*
                          * Warn about bogus characters.  If you're using                           * Warn about bogus characters.  If you're using
                          * non-ASCII encoding, you're screwing your                           * non-ASCII encoding, you're screwing your
                          * readers.  Since I'd rather this not happen,                           * readers.  Since I'd rather this not happen,
                          * I'll be helpful and drop these characters so                           * I'll be helpful and replace these characters
                          * we don't display gibberish.  Note to manual                           * with "?", so we don't display gibberish.
                          * writers: use special characters.                           * Note to manual writers: use special characters.
                          */                           */
   
                         c = (unsigned char) blk.buf[i];                          c = (unsigned char) blk.buf[i];
Line 332  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 349  mparse_buf_r(struct mparse *curp, struct buf blk, int 
                         if ( ! (isascii(c) &&                          if ( ! (isascii(c) &&
                                         (isgraph(c) || isblank(c)))) {                                          (isgraph(c) || isblank(c)))) {
                                 mandoc_msg(MANDOCERR_BADCHAR, curp,                                  mandoc_msg(MANDOCERR_BADCHAR, curp,
                                                 curp->line, pos, "ignoring byte");                                                  curp->line, pos, NULL);
                                 i++;                                  i++;
                                   ln.buf[pos++] = '?';
                                 continue;                                  continue;
                         }                          }
   
                         /* 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 == (int)blk.sz) {
                                 if (pos >= (int)ln.sz)  
                                         resize_buf(&ln, 256);  
                                 ln.buf[pos++] = blk.buf[i++];                                  ln.buf[pos++] = blk.buf[i++];
                                 continue;                                  continue;
                         }                          }
Line 383  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 399  mparse_buf_r(struct mparse *curp, struct buf blk, int 
                                 break;                                  break;
                         }                          }
   
                         /* Some other escape sequence, copy & cont. */                          /* Catch escaped bogus characters. */
   
                         if (pos + 1 >= (int)ln.sz)                          c = (unsigned char) blk.buf[i+1];
                                 resize_buf(&ln, 256);  
   
                           if ( ! (isascii(c) &&
                                           (isgraph(c) || isblank(c)))) {
                                   mandoc_msg(MANDOCERR_BADCHAR, curp,
                                                   curp->line, pos, NULL);
                                   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++];                          ln.buf[pos++] = blk.buf[i++];
                 }                  }
Line 408  mparse_buf_r(struct mparse *curp, struct buf blk, int 
Line 434  mparse_buf_r(struct mparse *curp, struct buf blk, int 
   
                 of = 0;                  of = 0;
   
                   /*
                    * Maintain a lookaside buffer of all parsed lines.  We
                    * only do this if mparse_keep() has been invoked (the
                    * buffer may be accessed with mparse_getkeep()).
                    */
   
                   if (curp->secondary) {
                           curp->secondary->buf =
                                   mandoc_realloc
                                   (curp->secondary->buf,
                                    curp->secondary->sz + pos + 2);
                           memcpy(curp->secondary->buf +
                                           curp->secondary->sz,
                                           ln.buf, pos);
                           curp->secondary->sz += pos;
                           curp->secondary->buf
                                   [curp->secondary->sz] = '\n';
                           curp->secondary->sz++;
                           curp->secondary->buf
                                   [curp->secondary->sz] = '\0';
                   }
 rerun:  rerun:
                 rr = roff_parseln                  rr = roff_parseln
                         (curp->roff, curp->line,                          (curp->roff, curp->line,
Line 434  rerun:
Line 481  rerun:
                         assert(MANDOCLEVEL_FATAL <= curp->file_status);                          assert(MANDOCLEVEL_FATAL <= curp->file_status);
                         break;                          break;
                 case (ROFF_SO):                  case (ROFF_SO):
                         mparse_readfd_r(curp, -1, ln.buf + of, 1);                          /*
                            * We remove `so' clauses from our lookaside
                            * buffer because we're going to descend into
                            * the file recursively.
                            */
                           if (curp->secondary)
                                   curp->secondary->sz -= pos + 1;
                           mparse_readfd(curp, -1, ln.buf + of);
                         if (MANDOCLEVEL_FATAL <= curp->file_status)                          if (MANDOCLEVEL_FATAL <= curp->file_status)
                                 break;                                  break;
                         pos = 0;                          pos = 0;
Line 513  rerun:
Line 567  rerun:
         free(ln.buf);          free(ln.buf);
 }  }
   
 static void  
 pdesc(struct mparse *curp, const char *file, int fd)  
 {  
         struct buf       blk;  
         int              with_mmap;  
   
         /*  
          * Run for each opened file; may be called more than once for  
          * each full parse sequence if the opened file is nested (i.e.,  
          * from `so').  Simply sucks in the whole file and moves into  
          * the parse phase for the file.  
          */  
   
         if ( ! read_whole_file(file, fd, &blk, &with_mmap)) {  
                 curp->file_status = MANDOCLEVEL_SYSERR;  
                 return;  
         }  
   
         /* Line number is per-file. */  
   
         curp->line = 1;  
   
         mparse_buf_r(curp, blk, 1);  
   
 #ifdef  HAVE_MMAP  
         if (with_mmap)  
                 munmap(blk.buf, blk.sz);  
         else  
 #endif  
                 free(blk.buf);  
 }  
   
 static int  static int
 read_whole_file(const char *file, int fd, struct buf *fb, int *with_mmap)  read_whole_file(const char *file, int fd, struct buf *fb, int *with_mmap)
 {  {
Line 572  read_whole_file(const char *file, int fd, struct buf *
Line 594  read_whole_file(const char *file, int fd, struct buf *
                 }                  }
                 *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);
         }          }
Line 640  mparse_end(struct mparse *curp)
Line 661  mparse_end(struct mparse *curp)
 }  }
   
 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)
 {  {
         const char      *svfile;          const char      *svfile;
           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;
           curp->line = 1;
           recursion_depth++;
   
         pdesc(curp, file, fd);          mparse_buf_r(curp, blk, 1);
   
         if (0 == re && MANDOCLEVEL_FATAL > curp->file_status)          if (0 == --recursion_depth && MANDOCLEVEL_FATAL > curp->file_status)
                 mparse_end(curp);                  mparse_end(curp);
   
         if (STDIN_FILENO != fd && -1 == close(fd))  
                 perror(file);  
   
         curp->file = svfile;          curp->file = svfile;
 }  }
   
 enum mandoclevel  enum mandoclevel
   mparse_readmem(struct mparse *curp, const void *buf, size_t len,
                   const char *file)
   {
           struct buf blk;
   
           blk.buf = UNCONST(buf);
           blk.sz = len;
   
           mparse_parse_buffer(curp, blk, file);
           return(curp->file_status);
   }
   
   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;
   
         mparse_readfd_r(curp, fd, file, 0);          if (-1 == fd)
                   if (-1 == (fd = open(file, O_RDONLY, 0))) {
                           perror(file);
                           curp->file_status = MANDOCLEVEL_SYSERR;
                           goto out;
                   }
           /*
            * 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;
                   goto out;
           }
   
           mparse_parse_buffer(curp, blk, file);
   
   #ifdef  HAVE_MMAP
           if (with_mmap)
                   munmap(blk.buf, blk.sz);
           else
   #endif
                   free(blk.buf);
   
           if (STDIN_FILENO != fd && -1 == close(fd))
                   perror(file);
   out:
         return(curp->file_status);          return(curp->file_status);
 }  }
   
 struct mparse *  struct mparse *
 mparse_alloc(enum mparset inttype, enum mandoclevel wlevel, mandocmsg mmsg, void *arg)  mparse_alloc(enum mparset inttype, enum mandoclevel wlevel,
                   mandocmsg mmsg, void *arg, char *defos)
 {  {
         struct mparse   *curp;          struct mparse   *curp;
   
Line 686  mparse_alloc(enum mparset inttype, enum mandoclevel wl
Line 751  mparse_alloc(enum mparset inttype, enum mandoclevel wl
         curp->mmsg = mmsg;          curp->mmsg = mmsg;
         curp->arg = arg;          curp->arg = arg;
         curp->inttype = inttype;          curp->inttype = inttype;
           curp->defos = defos;
   
         curp->roff = roff_alloc(curp);          curp->roff = roff_alloc(inttype, curp);
         return(curp);          return(curp);
 }  }
   
Line 701  mparse_reset(struct mparse *curp)
Line 767  mparse_reset(struct mparse *curp)
                 mdoc_reset(curp->mdoc);                  mdoc_reset(curp->mdoc);
         if (curp->man)          if (curp->man)
                 man_reset(curp->man);                  man_reset(curp->man);
           if (curp->secondary)
                   curp->secondary->sz = 0;
   
         curp->file_status = MANDOCLEVEL_OK;          curp->file_status = MANDOCLEVEL_OK;
         curp->mdoc = NULL;          curp->mdoc = NULL;
Line 717  mparse_free(struct mparse *curp)
Line 785  mparse_free(struct mparse *curp)
                 man_free(curp->pman);                  man_free(curp->pman);
         if (curp->roff)          if (curp->roff)
                 roff_free(curp->roff);                  roff_free(curp->roff);
           if (curp->secondary)
                   free(curp->secondary->buf);
   
           free(curp->secondary);
         free(curp);          free(curp);
 }  }
   
Line 776  const char *
Line 847  const char *
 mparse_strlevel(enum mandoclevel lvl)  mparse_strlevel(enum mandoclevel lvl)
 {  {
         return(mandoclevels[lvl]);          return(mandoclevels[lvl]);
   }
   
   void
   mparse_keep(struct mparse *p)
   {
   
           assert(NULL == p->secondary);
           p->secondary = mandoc_calloc(1, sizeof(struct buf));
   }
   
   const char *
   mparse_getkeep(const struct mparse *p)
   {
   
           assert(p->secondary);
           return(p->secondary->sz ? p->secondary->buf : NULL);
 }  }
Legend:
Removed from v.1.19  
changed lines
  Added in v.1.38
CVSweb