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

Diff for /mandoc/main.c between version 1.23 and 1.147

version 1.23, 2009/04/03 12:27:18 version 1.147, 2011/03/07 01:35:51
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010, 2011 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   * purpose with or without fee is hereby granted, provided that the above
  * above copyright notice and this permission notice appear in all   * copyright notice and this permission notice appear in all copies.
  * copies.  
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * PERFORMANCE OF THIS SOFTWARE.  
  */   */
   #ifdef HAVE_CONFIG_H
   #include "config.h"
   #endif
   
   #include <sys/mman.h>
 #include <sys/stat.h>  #include <sys/stat.h>
   
 #include <assert.h>  #include <assert.h>
 #include <err.h>  #include <ctype.h>
 #include <fcntl.h>  #include <fcntl.h>
 #include <stdio.h>  #include <stdio.h>
   #include <stdint.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
 #include <unistd.h>  #include <unistd.h>
   
   #include "mandoc.h"
   #include "main.h"
 #include "mdoc.h"  #include "mdoc.h"
 #include "man.h"  #include "man.h"
   #include "roff.h"
   
 /* Account for FreeBSD and Linux in our declarations. */  #ifndef MAP_FILE
   #define MAP_FILE        0
   #endif
   
 #ifdef __linux__  #define REPARSE_LIMIT   1000
 extern  int               getsubopt(char **, char * const *, char **);  #define UNCONST(a)      ((void *)(uintptr_t)(const void *)(a))
 # ifndef __dead  
 #  define __dead __attribute__((__noreturn__))  /* FIXME: Intel's compiler?  LLVM?  pcc?  */
   
   #if !defined(__GNUC__) || (__GNUC__ < 2)
   # if !defined(lint)
   #  define __attribute__(x)
 # endif  # endif
 #elif defined(__dead2)  #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
 # ifndef __dead  
 #  define __dead __dead2  
 # endif  
 #endif  
   
 typedef int             (*out_mdoc)(void *, const struct mdoc *);  typedef void            (*out_mdoc)(void *, const struct mdoc *);
 typedef int             (*out_man)(void *, const struct man *);  typedef void            (*out_man)(void *, const struct man *);
 typedef void            (*out_free)(void *);  typedef void            (*out_free)(void *);
   
 struct  buf {  struct  buf {
Line 60  enum intt {
Line 70  enum intt {
 enum    outt {  enum    outt {
         OUTT_ASCII = 0,          OUTT_ASCII = 0,
         OUTT_TREE,          OUTT_TREE,
         OUTT_LINT          OUTT_HTML,
           OUTT_XHTML,
           OUTT_LINT,
           OUTT_PS,
           OUTT_PDF
 };  };
   
 struct  curparse {  struct  curparse {
         const char       *file;         /* Current parse. */          const char       *file;         /* Current parse. */
         int               fd;           /* Current parse. */          int               fd;           /* Current parse. */
         int               wflags;          int               line;         /* Line number in the file. */
 #define WARN_WALL         0x03          /* All-warnings mask. */          enum mandoclevel  wlevel;       /* Ignore messages below this. */
 #define WARN_WCOMPAT     (1 << 0)       /* Compatibility warnings. */          int               wstop;        /* Stop after a file with a warning. */
 #define WARN_WSYNTAX     (1 << 1)       /* Syntax warnings. */          enum intt         inttype;      /* which parser to use */
 #define WARN_WERR        (1 << 2)       /* Warnings->errors. */          struct man       *pman;         /* persistent man parser */
         int               fflags;          struct mdoc      *pmdoc;        /* persistent mdoc parser */
 #define IGN_SCOPE        (1 << 0)       /* Ignore scope errors. */          struct man       *man;          /* man parser */
 #define IGN_ESCAPE       (1 << 1)       /* Ignore bad escapes. */          struct mdoc      *mdoc;         /* mdoc parser */
 #define IGN_MACRO        (1 << 2)       /* Ignore unknown macros. */          struct roff      *roff;         /* roff parser (!NULL) */
 #define NO_IGN_MACRO     (1 << 3)          struct regset     regs;         /* roff registers */
         enum intt         inttype;      /* Input parsers. */          int               reparse_count; /* finite interpolation stack */
         struct man       *man;          enum outt         outtype;      /* which output to use */
         struct man       *lastman;          out_mdoc          outmdoc;      /* mdoc output ptr */
         struct mdoc      *mdoc;          out_man           outman;       /* man output ptr */
         struct mdoc      *lastmdoc;          out_free          outfree;      /* free output ptr */
         enum outt         outtype;      /* Output devices. */          void             *outdata;      /* data for output */
         out_mdoc          outmdoc;          char              outopts[BUFSIZ]; /* buf of output opts */
         out_man           outman;  
         out_free          outfree;  
         void             *outdata;  
 };  };
   
 extern  void             *ascii_alloc(void);  static  const char * const      mandoclevels[MANDOCLEVEL_MAX] = {
 extern  int               tree_mdoc(void *, const struct mdoc *);          "SUCCESS",
 extern  int               tree_man(void *, const struct man *);          "RESERVED",
 extern  int               terminal_mdoc(void *, const struct mdoc *);          "WARNING",
 extern  int               terminal_man(void *, const struct man *);          "ERROR",
 extern  void              terminal_free(void *);          "FATAL",
           "BADARG",
           "SYSERR"
   };
   
 static  int               foptions(int *, char *);  static  const enum mandocerr    mandoclimits[MANDOCLEVEL_MAX] = {
 static  int               toptions(enum outt *, char *);          MANDOCERR_OK,
 static  int               moptions(enum intt *, char *);          MANDOCERR_WARNING,
 static  int               woptions(int *, char *);          MANDOCERR_WARNING,
 static  int               merr(void *, int, int, const char *);          MANDOCERR_ERROR,
 static  int               manwarn(void *, int, int, const char *);          MANDOCERR_FATAL,
 static  int               mdocwarn(void *, int, int,          MANDOCERR_MAX,
                                 enum mdoc_warn, const char *);          MANDOCERR_MAX
 static  int               fstdin(struct buf *, struct buf *,  };
                                 struct curparse *);  
 static  int               ffile(struct buf *, struct buf *,  
                                 const char *, struct curparse *);  
 static  int               fdesc(struct buf *, struct buf *,  
                                 struct curparse *);  
 static  int               pset(const char *, int, struct curparse *,  
                                 struct man **, struct mdoc **);  
 static  struct man       *man_init(struct curparse *);  
 static  struct mdoc      *mdoc_init(struct curparse *);  
 __dead  static void       version(void);  
 __dead  static void       usage(void);  
   
 extern  char             *__progname;  static  const char * const      mandocerrs[MANDOCERR_MAX] = {
           "ok",
   
           "generic warning",
   
           /* related to the prologue */
           "no title in document",
           "document title should be all caps",
           "unknown manual section",
           "date missing, using today's date",
           "cannot parse date, using it verbatim",
           "prologue macros out of order",
           "duplicate prologue macro",
           "macro not allowed in prologue",
           "macro not allowed in body",
   
           /* related to document structure */
           ".so is fragile, better use ln(1)",
           "NAME section must come first",
           "bad NAME section contents",
           "manual name not yet set",
           "sections out of conventional order",
           "duplicate section name",
           "section not in conventional manual section",
   
           /* related to macros and nesting */
           "skipping obsolete macro",
           "skipping paragraph macro",
           "skipping no-space macro",
           "blocks badly nested",
           "child violates parent syntax",
           "nested displays are not portable",
           "already in literal mode",
   
           /* related to missing macro arguments */
           "skipping empty macro",
           "argument count wrong",
           "missing display type",
           "list type must come first",
           "tag lists require a width argument",
           "missing font type",
           "skipping end of block that is not open",
   
           /* related to bad macro arguments */
           "skipping argument",
           "duplicate argument",
           "duplicate display type",
           "duplicate list type",
           "unknown AT&T UNIX version",
           "bad Boolean value",
           "unknown font",
           "unknown standard specifier",
           "bad width argument",
   
           /* related to plain text */
           "blank line in non-literal context",
           "tab in non-literal context",
           "end of line whitespace",
           "bad comment style",
           "unknown escape sequence",
           "unterminated quoted string",
   
           "generic error",
   
           /* related to tables */
           "bad table syntax",
           "bad table option",
           "bad table layout",
           "no table layout cells specified",
           "no table data cells specified",
           "ignore data in cell",
           "data block still open",
           "ignoring extra data cells",
   
           "input stack limit exceeded, infinite loop?",
           "skipping bad character",
           "escaped character not allowed in a name",
           "skipping text before the first section header",
           "skipping unknown macro",
           "NOT IMPLEMENTED, please use groff: skipping request",
           "line scope broken",
           "argument count wrong",
           "skipping end of block that is not open",
           "missing end of block",
           "scope open on exit",
           "uname(3) system call failed",
           "macro requires line argument(s)",
           "macro requires body argument(s)",
           "macro requires argument(s)",
           "missing list type",
           "line argument(s) will be lost",
           "body argument(s) will be lost",
   
           "generic fatal error",
   
           "column syntax is inconsistent",
           "NOT IMPLEMENTED: .Bd -file",
           "line scope broken, syntax violated",
           "argument count wrong, violates syntax",
           "child violates parent syntax",
           "argument count wrong, violates syntax",
           "NOT IMPLEMENTED: .so with absolute path or \"..\"",
           "no document body",
           "no document prologue",
           "static buffer exhausted",
   };
   
   static  void              parsebuf(struct curparse *, struct buf, int);
   static  void              pdesc(struct curparse *);
   static  void              fdesc(struct curparse *);
   static  void              ffile(const char *, struct curparse *);
   static  int               pfile(const char *, struct curparse *);
   static  int               moptions(enum intt *, char *);
   static  int               mmsg(enum mandocerr, void *,
                                   int, int, const char *);
   static  void              pset(const char *, int, struct curparse *);
   static  int               toptions(struct curparse *, char *);
   static  void              usage(void) __attribute__((noreturn));
   static  void              version(void) __attribute__((noreturn));
   static  int               woptions(struct curparse *, char *);
   
   static  const char       *progname;
   static  enum mandoclevel  file_status = MANDOCLEVEL_OK;
   static  enum mandoclevel  exit_status = MANDOCLEVEL_OK;
   
 int  int
 main(int argc, char *argv[])  main(int argc, char *argv[])
 {  {
         int              c, rc;          int              c;
         struct buf       ln, blk;  
         struct curparse  curp;          struct curparse  curp;
   
         bzero(&curp, sizeof(struct curparse));          progname = strrchr(argv[0], '/');
           if (progname == NULL)
                   progname = argv[0];
           else
                   ++progname;
   
           memset(&curp, 0, sizeof(struct curparse));
   
         curp.inttype = INTT_AUTO;          curp.inttype = INTT_AUTO;
         curp.outtype = OUTT_ASCII;          curp.outtype = OUTT_ASCII;
           curp.wlevel  = MANDOCLEVEL_FATAL;
   
         /* LINTED */          /* LINTED */
         while (-1 != (c = getopt(argc, argv, "f:m:VW:T:")))          while (-1 != (c = getopt(argc, argv, "m:O:T:VW:")))
                 switch (c) {                  switch (c) {
                 case ('f'):  
                         if ( ! foptions(&curp.fflags, optarg))  
                                 return(0);  
                         break;  
                 case ('m'):                  case ('m'):
                         if ( ! moptions(&curp.inttype, optarg))                          if ( ! moptions(&curp.inttype, optarg))
                                 return(0);                                  return((int)MANDOCLEVEL_BADARG);
                         break;                          break;
                   case ('O'):
                           (void)strlcat(curp.outopts, optarg, BUFSIZ);
                           (void)strlcat(curp.outopts, ",", BUFSIZ);
                           break;
                 case ('T'):                  case ('T'):
                         if ( ! toptions(&curp.outtype, optarg))                          if ( ! toptions(&curp, optarg))
                                 return(0);                                  return((int)MANDOCLEVEL_BADARG);
                         break;                          break;
                 case ('W'):                  case ('W'):
                         if ( ! woptions(&curp.wflags, optarg))                          if ( ! woptions(&curp, optarg))
                                 return(0);                                  return((int)MANDOCLEVEL_BADARG);
                         break;                          break;
                 case ('V'):                  case ('V'):
                         version();                          version();
Line 161  main(int argc, char *argv[])
Line 292  main(int argc, char *argv[])
         argc -= optind;          argc -= optind;
         argv += optind;          argv += optind;
   
         /* Configure buffers. */          if (NULL == *argv) {
                   curp.file = "<stdin>";
                   curp.fd = STDIN_FILENO;
   
         bzero(&ln, sizeof(struct buf));                  fdesc(&curp);
         bzero(&blk, sizeof(struct buf));          }
   
         rc = 1;          while (*argv) {
                   ffile(*argv, &curp);
         if (NULL == *argv)                  if (MANDOCLEVEL_OK != exit_status && curp.wstop)
                 if ( ! fstdin(&blk, &ln, &curp))                          break;
                         rc = 0;                  ++argv;
   
         while (rc && *argv) {  
                 if ( ! ffile(&blk, &ln, *argv, &curp))  
                         rc = 0;  
                 argv++;  
                 if (*argv && rc) {  
                         if (curp.lastman)  
                                 if ( ! man_reset(curp.lastman))  
                                         rc = 0;  
                         if (curp.lastmdoc)  
                                 if ( ! mdoc_reset(curp.lastmdoc))  
                                         rc = 0;  
                         curp.lastman = NULL;  
                         curp.lastmdoc = NULL;  
                 }  
         }          }
   
         if (blk.buf)  
                 free(blk.buf);  
         if (ln.buf)  
                 free(ln.buf);  
         if (curp.outfree)          if (curp.outfree)
                 (*curp.outfree)(curp.outdata);                  (*curp.outfree)(curp.outdata);
         if (curp.mdoc)          if (curp.pmdoc)
                 mdoc_free(curp.mdoc);                  mdoc_free(curp.pmdoc);
         if (curp.man)          if (curp.pman)
                 man_free(curp.man);                  man_free(curp.pman);
           if (curp.roff)
                   roff_free(curp.roff);
   
         return(rc ? EXIT_SUCCESS : EXIT_FAILURE);          return((int)exit_status);
 }  }
   
   
 __dead static void  static void
 version(void)  version(void)
 {  {
   
         (void)printf("%s %s\n", __progname, VERSION);          (void)printf("%s %s\n", progname, VERSION);
         exit(EXIT_SUCCESS);          exit((int)MANDOCLEVEL_OK);
 }  }
   
   
 __dead static void  static void
 usage(void)  usage(void)
 {  {
   
         (void)fprintf(stderr, "usage: %s [-V] [-foption...] "          (void)fprintf(stderr, "usage: %s "
                         "[-mformat] [-Toutput] [-Werr...]\n",                          "[-V] "
                         __progname);                          "[-foption] "
         exit(EXIT_FAILURE);                          "[-mformat] "
                           "[-Ooption] "
                           "[-Toutput] "
                           "[-Werr] "
                           "[file...]\n",
                           progname);
   
           exit((int)MANDOCLEVEL_BADARG);
 }  }
   
   static void
 static struct man *  ffile(const char *file, struct curparse *curp)
 man_init(struct curparse *curp)  
 {  {
         int              pflags;  
         struct man      *man;  
         struct man_cb    mancb;  
   
         mancb.man_err = merr;          /*
         mancb.man_warn = manwarn;           * Called once per input file.  Get the file ready for reading,
            * pass it through to the parser-driver, then close it out.
            * XXX: don't do anything special as this is only called for
            * files; stdin goes directly to fdesc().
            */
   
         pflags = MAN_IGN_MACRO; /* XXX */          curp->file = file;
   
         if (curp->fflags & NO_IGN_MACRO)          if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {
                 pflags &= ~MAN_IGN_MACRO;                  perror(curp->file);
                   exit_status = MANDOCLEVEL_SYSERR;
                   return;
           }
   
         if (NULL == (man = man_alloc(curp, pflags, &mancb)))          fdesc(curp);
                 warnx("memory exhausted");  
   
         return(man);          if (-1 == close(curp->fd))
                   perror(curp->file);
 }  }
   
   static int
 static struct mdoc *  pfile(const char *file, struct curparse *curp)
 mdoc_init(struct curparse *curp)  
 {  {
         int              pflags;          const char      *savefile;
         struct mdoc     *mdoc;          int              fd, savefd;
         struct mdoc_cb   mdoccb;  
   
         mdoccb.mdoc_msg = NULL;          if (-1 == (fd = open(file, O_RDONLY, 0))) {
         mdoccb.mdoc_err = merr;                  perror(file);
         mdoccb.mdoc_warn = mdocwarn;                  file_status = MANDOCLEVEL_SYSERR;
                   return(0);
           }
   
         pflags = 0; /* XXX */          savefile = curp->file;
           savefd = curp->fd;
   
         if (curp->fflags & IGN_SCOPE)          curp->file = file;
                 pflags |= MDOC_IGN_SCOPE;          curp->fd = fd;
         if (curp->fflags & IGN_ESCAPE)  
                 pflags |= MDOC_IGN_ESCAPE;  
         if (curp->fflags & IGN_MACRO)  
                 pflags |= MDOC_IGN_MACRO;  
   
         if (NULL == (mdoc = mdoc_alloc(curp, pflags, &mdoccb)))          pdesc(curp);
                 warnx("memory allocated");  
   
         return(mdoc);          curp->file = savefile;
 }          curp->fd = savefd;
   
           if (-1 == close(fd))
                   perror(file);
   
 static int          return(MANDOCLEVEL_FATAL > file_status ? 1 : 0);
 fstdin(struct buf *blk, struct buf *ln, struct curparse *curp)  
 {  
   
         curp->file = "<stdin>";  
         curp->fd = STDIN_FILENO;  
         return(fdesc(blk, ln, curp));  
 }  }
   
   
 static int  static void
 ffile(struct buf *blk, struct buf *ln,  resize_buf(struct buf *buf, size_t initial)
                 const char *file, struct curparse *curp)  
 {  {
         int              c;  
   
         curp->file = file;          buf->sz = buf->sz > initial/2 ? 2 * buf->sz : initial;
         if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {          buf->buf = realloc(buf->buf, buf->sz);
                 warn("%s", curp->file);          if (NULL == buf->buf) {
                 return(0);                  perror(NULL);
                   exit((int)MANDOCLEVEL_SYSERR);
         }          }
   
         c = fdesc(blk, ln, curp);  
   
         if (-1 == close(curp->fd))  
                 warn("%s", curp->file);  
   
         return(c);  
 }  }
   
   
 static int  static int
 fdesc(struct buf *blk, struct buf *ln, struct curparse *curp)  read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap)
 {  {
         size_t           sz;  
         ssize_t          ssz;  
         struct stat      st;          struct stat      st;
         int              j, i, pos, lnn;          size_t           off;
         struct man      *man;          ssize_t          ssz;
         struct mdoc     *mdoc;  
   
         sz = BUFSIZ;          if (-1 == fstat(curp->fd, &st)) {
         man = NULL;                  perror(curp->file);
         mdoc = NULL;                  return(0);
           }
   
         /*          /*
          * Two buffers: ln and buf.  buf is the input buffer optimised           * If we're a regular file, try just reading in the whole entry
          * here for each file's block size.  ln is a line buffer.  Both           * via mmap().  This is faster than reading it into blocks, and
          * growable, hence passed in by ptr-ptr.           * since each file is only a few bytes to begin with, I'm not
            * concerned that this is going to tank any machines.
          */           */
   
         if (-1 == fstat(curp->fd, &st))          if (S_ISREG(st.st_mode)) {
                 warnx("%s", curp->file);                  if (st.st_size >= (1U << 31)) {
         else if ((size_t)st.st_blksize > sz)                          fprintf(stderr, "%s: input too large\n",
                 sz = st.st_blksize;                                          curp->file);
   
         if (sz > blk->sz) {  
                 blk->buf = realloc(blk->buf, sz);  
                 if (NULL == blk->buf) {  
                         warn("realloc");  
                         return(0);                          return(0);
                 }                  }
                 blk->sz = sz;                  *with_mmap = 1;
                   fb->sz = (size_t)st.st_size;
                   fb->buf = mmap(NULL, fb->sz, PROT_READ,
                                   MAP_FILE|MAP_SHARED, curp->fd, 0);
                   if (fb->buf != MAP_FAILED)
                           return(1);
         }          }
   
         /* Fill buf with file blocksize. */          /*
            * 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.
            */
   
         for (lnn = 0, pos = 0; ; ) {          *with_mmap = 0;
                 if (-1 == (ssz = read(curp->fd, blk->buf, sz))) {          off = 0;
                         warn("%s", curp->file);          fb->sz = 0;
                         return(0);          fb->buf = NULL;
                 } else if (0 == ssz)          for (;;) {
                   if (off == fb->sz) {
                           if (fb->sz == (1U << 31)) {
                                   fprintf(stderr, "%s: input too large\n",
                                                   curp->file);
                                   break;
                           }
                           resize_buf(fb, 65536);
                   }
                   ssz = read(curp->fd, fb->buf + (int)off, fb->sz - off);
                   if (ssz == 0) {
                           fb->sz = off;
                           return(1);
                   }
                   if (ssz == -1) {
                           perror(curp->file);
                         break;                          break;
                   }
                   off += (size_t)ssz;
           }
   
                 /* Parse the read block into partial or full lines. */          free(fb->buf);
           fb->buf = NULL;
           return(0);
   }
   
                 for (i = 0; i < (int)ssz; i++) {  
                         if (pos >= (int)ln->sz) {  
                                 ln->sz += 256; /* Step-size. */  
                                 ln->buf = realloc(ln->buf, ln->sz);  
                                 if (NULL == ln->buf) {  
                                         warn("realloc");  
                                         return(0);  
                                 }  
                         }  
   
                         if ('\n' != blk->buf[i]) {  static void
                                 ln->buf[pos++] = blk->buf[i];  fdesc(struct curparse *curp)
                                 continue;  {
                         }  
   
                         /* Check for CPP-escaped newline.  */          /*
            * Called once per file with an opened file descriptor.  All
            * pre-file-parse operations (whether stdin or a file) should go
            * here.
            *
            * This calls down into the nested parser, which drills down and
            * fully parses a file and all its dependences (i.e., `so').  It
            * then runs the cleanup validators and pushes to output.
            */
   
                         if (pos > 0 && '\\' == ln->buf[pos - 1]) {          /* Zero the parse type. */
                                 for (j = pos - 1; j >= 0; j--)  
                                         if ('\\' != ln->buf[j])  
                                                 break;  
   
                                 if ( ! ((pos - j) % 2)) {          curp->mdoc = NULL;
                                         pos--;          curp->man = NULL;
                                         lnn++;          file_status = MANDOCLEVEL_OK;
                                         continue;  
                                 }  
                         }  
   
                         ln->buf[pos] = 0;          /* Make sure the mandotory roff parser is initialised. */
                         lnn++;  
   
                         /*  
                          * If no manual parser has been assigned, then  
                          * try to assign one in pset(), which may do  
                          * nothing at all.  After this, parse the manual  
                          * line accordingly.  
                          */  
   
                         if ( ! (man || mdoc) && ! pset(ln->buf,          if (NULL == curp->roff) {
                                                 pos, curp, &man, &mdoc))                  curp->roff = roff_alloc(&curp->regs, curp, mmsg);
                                 return(0);                  assert(curp->roff);
           }
   
                         pos = 0;          /* Fully parse the file. */
   
                         if (man && ! man_parseln(man, lnn, ln->buf))          pdesc(curp);
                                 return(0);  
                         if (mdoc && ! mdoc_parseln(mdoc, lnn, ln->buf))          if (MANDOCLEVEL_FATAL <= file_status)
                                 return(0);                  goto cleanup;
                 }  
           /* NOTE a parser may not have been assigned, yet. */
   
           if ( ! (curp->man || curp->mdoc)) {
                   fprintf(stderr, "%s: Not a manual\n", curp->file);
                   file_status = MANDOCLEVEL_FATAL;
                   goto cleanup;
         }          }
   
         /* Note that a parser may not have been assigned, yet. */          /* Clean up the parse routine ASTs. */
   
         if ( ! (man || mdoc)) {          if (curp->mdoc && ! mdoc_endparse(curp->mdoc)) {
                 warnx("%s: not a manual", curp->file);                  assert(MANDOCLEVEL_FATAL <= file_status);
                 return(0);                  goto cleanup;
         }          }
   
         if (mdoc && ! mdoc_endparse(mdoc))          if (curp->man && ! man_endparse(curp->man)) {
                 return(0);                  assert(MANDOCLEVEL_FATAL <= file_status);
         if (man && ! man_endparse(man))                  goto cleanup;
                 return(0);          }
   
           assert(curp->roff);
           roff_endparse(curp->roff);
   
         /*          /*
          * If an output device hasn't been allocated, see if we should           * With -Wstop and warnings or errors of at least
          * do so now.  Note that not all outtypes have functions, so           * the requested level, do not produce output.
          * this switch statement may be superfluous, but it's  
          * low-overhead enough not to matter very much.  
          */           */
   
           if (MANDOCLEVEL_OK != file_status && curp->wstop)
                   goto cleanup;
   
           /* If unset, allocate output dev now (if applicable). */
   
         if ( ! (curp->outman && curp->outmdoc)) {          if ( ! (curp->outman && curp->outmdoc)) {
                 switch (curp->outtype) {                  switch (curp->outtype) {
                   case (OUTT_XHTML):
                           curp->outdata = xhtml_alloc(curp->outopts);
                           break;
                   case (OUTT_HTML):
                           curp->outdata = html_alloc(curp->outopts);
                           break;
                   case (OUTT_ASCII):
                           curp->outdata = ascii_alloc(curp->outopts);
                           curp->outfree = ascii_free;
                           break;
                   case (OUTT_PDF):
                           curp->outdata = pdf_alloc(curp->outopts);
                           curp->outfree = pspdf_free;
                           break;
                   case (OUTT_PS):
                           curp->outdata = ps_alloc(curp->outopts);
                           curp->outfree = pspdf_free;
                           break;
                   default:
                           break;
                   }
   
                   switch (curp->outtype) {
                   case (OUTT_HTML):
                           /* FALLTHROUGH */
                   case (OUTT_XHTML):
                           curp->outman = html_man;
                           curp->outmdoc = html_mdoc;
                           curp->outfree = html_free;
                           break;
                 case (OUTT_TREE):                  case (OUTT_TREE):
                         curp->outman = tree_man;                          curp->outman = tree_man;
                         curp->outmdoc = tree_mdoc;                          curp->outmdoc = tree_mdoc;
                         break;                          break;
                 case (OUTT_LINT):                  case (OUTT_PDF):
                         break;                          /* FALLTHROUGH */
                 default:                  case (OUTT_ASCII):
                         curp->outdata = ascii_alloc();                          /* FALLTHROUGH */
                   case (OUTT_PS):
                         curp->outman = terminal_man;                          curp->outman = terminal_man;
                         curp->outmdoc = terminal_mdoc;                          curp->outmdoc = terminal_mdoc;
                         curp->outfree = terminal_free;  
                         break;                          break;
                   default:
                           break;
                 }                  }
         }          }
   
         /* Execute the out device, if it exists. */          /* Execute the out device, if it exists. */
   
         if (man && curp->outman)          if (curp->man && curp->outman)
                 if ( ! (*curp->outman)(curp->outdata, man))                  (*curp->outman)(curp->outdata, curp->man);
                         return(0);          if (curp->mdoc && curp->outmdoc)
         if (mdoc && curp->outmdoc)                  (*curp->outmdoc)(curp->outdata, curp->mdoc);
                 if ( ! (*curp->outmdoc)(curp->outdata, mdoc))  
                         return(0);  
   
         return(1);   cleanup:
   
           memset(&curp->regs, 0, sizeof(struct regset));
   
           /* Reset the current-parse compilers. */
   
           if (curp->mdoc)
                   mdoc_reset(curp->mdoc);
           if (curp->man)
                   man_reset(curp->man);
   
           assert(curp->roff);
           roff_reset(curp->roff);
   
           if (exit_status < file_status)
                   exit_status = file_status;
   
           return;
 }  }
   
   static void
   pdesc(struct curparse *curp)
   {
           struct buf       blk;
           int              with_mmap;
   
 static int          /*
 pset(const char *buf, int pos, struct curparse *curp,           * Run for each opened file; may be called more than once for
                 struct man **man, struct mdoc **mdoc)           * 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(curp, &blk, &with_mmap)) {
                   file_status = MANDOCLEVEL_SYSERR;
                   return;
           }
   
           /* Line number is per-file. */
   
           curp->line = 1;
   
           parsebuf(curp, blk, 1);
   
           if (with_mmap)
                   munmap(blk.buf, blk.sz);
           else
                   free(blk.buf);
   }
   
   static void
   parsebuf(struct curparse *curp, struct buf blk, int start)
 {  {
           const struct tbl_span   *span;
           struct buf       ln;
           enum rofferr     rr;
           int              i, of, rc;
           int              pos; /* byte number in the ln buffer */
           int              lnn; /* line number in the real file */
           unsigned char    c;
   
         /*          /*
            * Main parse routine for an opened file.  This is called for
            * each opened file and simply loops around the full input file,
            * possibly nesting (i.e., with `so').
            */
   
           memset(&ln, 0, sizeof(struct buf));
   
           lnn = curp->line;
           pos = 0;
   
           for (i = 0; i < (int)blk.sz; ) {
                   if (0 == pos && '\0' == blk.buf[i])
                           break;
   
                   if (start) {
                           curp->line = lnn;
                           curp->reparse_count = 0;
                   }
   
                   while (i < (int)blk.sz && (start || '\0' != blk.buf[i])) {
   
                           /*
                            * When finding an unescaped newline character,
                            * leave the character loop to process the line.
                            * Skip a preceding carriage return, if any.
                            */
   
                           if ('\r' == blk.buf[i] && i + 1 < (int)blk.sz &&
                               '\n' == blk.buf[i + 1])
                                   ++i;
                           if ('\n' == blk.buf[i]) {
                                   ++i;
                                   ++lnn;
                                   break;
                           }
   
                           /*
                            * Warn about bogus characters.  If you're using
                            * non-ASCII encoding, you're screwing your
                            * 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 ( ! (isascii(c) &&
                                           (isgraph(c) || isblank(c)))) {
                                   mmsg(MANDOCERR_BADCHAR, curp,
                                       curp->line, pos, "ignoring byte");
                                   i++;
                                   continue;
                           }
   
                           /* Trailing backslash = a plain char. */
   
                           if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {
                                   if (pos >= (int)ln.sz)
                                           resize_buf(&ln, 256);
                                   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 < (int)blk.sz &&
                               '\n' == blk.buf[i + 2])
                                   ++i;
                           if ('\n' == blk.buf[i + 1]) {
                                   i += 2;
                                   ++lnn;
                                   continue;
                           }
   
                           if ('"' == blk.buf[i + 1]) {
                                   i += 2;
                                   /* Comment, skip to end of line */
                                   for (; i < (int)blk.sz; ++i) {
                                           if ('\n' == blk.buf[i]) {
                                                   ++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;
                           }
   
                           /* Some other escape sequence, copy & cont. */
   
                           if (pos + 1 >= (int)ln.sz)
                                   resize_buf(&ln, 256);
   
                           ln.buf[pos++] = blk.buf[i++];
                           ln.buf[pos++] = blk.buf[i++];
                   }
   
                   if (pos >= (int)ln.sz)
                           resize_buf(&ln, 256);
   
                   ln.buf[pos] = '\0';
   
                   /*
                    * A significant amount of complexity is contained by
                    * the roff preprocessor.  It's line-oriented but can be
                    * expressed on one line, so we need at times to
                    * readjust our starting point and re-run it.  The roff
                    * preprocessor can also readjust the buffers with new
                    * data, so we pass them in wholesale.
                    */
   
                   of = 0;
   
   rerun:
                   rr = roff_parseln
                           (curp->roff, curp->line,
                            &ln.buf, &ln.sz, of, &of);
   
                   switch (rr) {
                   case (ROFF_REPARSE):
                           if (REPARSE_LIMIT >= ++curp->reparse_count)
                                   parsebuf(curp, ln, 0);
                           else
                                   mmsg(MANDOCERR_ROFFLOOP, curp,
                                       curp->line, pos, NULL);
                           pos = 0;
                           continue;
                   case (ROFF_APPEND):
                           pos = strlen(ln.buf);
                           continue;
                   case (ROFF_RERUN):
                           goto rerun;
                   case (ROFF_IGN):
                           pos = 0;
                           continue;
                   case (ROFF_ERR):
                           assert(MANDOCLEVEL_FATAL <= file_status);
                           break;
                   case (ROFF_SO):
                           if (pfile(ln.buf + of, curp)) {
                                   pos = 0;
                                   continue;
                           } else
                                   break;
                   default:
                           break;
                   }
   
                   /*
                    * If we encounter errors in the recursive parsebuf()
                    * call, make sure we don't continue parsing.
                    */
   
                   if (MANDOCLEVEL_FATAL <= file_status)
                           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 <= file_status);
                           break;
                   }
   
                   /* Temporary buffers typically are not full. */
   
                   if (0 == start && '\0' == blk.buf[i])
                           break;
   
                   /* Start the next input line. */
   
                   pos = 0;
           }
   
           free(ln.buf);
   }
   
   static void
   pset(const char *buf, int pos, struct curparse *curp)
   {
           int              i;
   
           /*
          * Try to intuit which kind of manual parser should be used.  If           * Try to intuit which kind of manual parser should be used.  If
          * passed in by command-line (-man, -mdoc), then use that           * passed in by command-line (-man, -mdoc), then use that
          * explicitly.  If passed as -mandoc, then try to guess from the           * explicitly.  If passed as -mandoc, then try to guess from the
          * line: either skip comments, use -mdoc when finding `.Dt', or           * line: either skip dot-lines, use -mdoc when finding `.Dt', or
          * default to -man, which is more lenient.           * 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 (pos >= 3 && 0 == memcmp(buf, ".\\\"", 3))          if ('.' == buf[0] || '\'' == buf[0]) {
                 return(1);                  for (i = 1; buf[i]; i++)
                           if (' ' != buf[i] && '\t' != buf[i])
                                   break;
                   if ('\0' == buf[i])
                           return;
           }
   
         switch (curp->inttype) {          switch (curp->inttype) {
         case (INTT_MDOC):          case (INTT_MDOC):
                 if (NULL == curp->mdoc)                  if (NULL == curp->pmdoc)
                         curp->mdoc = mdoc_init(curp);                          curp->pmdoc = mdoc_alloc
                 if (NULL == (*mdoc = curp->mdoc))                                  (&curp->regs, curp, mmsg);
                         return(0);                  assert(curp->pmdoc);
                 curp->lastmdoc = *mdoc;                  curp->mdoc = curp->pmdoc;
                 return(1);                  return;
         case (INTT_MAN):          case (INTT_MAN):
                 if (NULL == curp->man)                  if (NULL == curp->pman)
                         curp->man = man_init(curp);                          curp->pman = man_alloc
                 if (NULL == (*man = curp->man))                                  (&curp->regs, curp, mmsg);
                         return(0);                  assert(curp->pman);
                 curp->lastman = *man;                  curp->man = curp->pman;
                 return(1);                  return;
         default:          default:
                 break;                  break;
         }          }
   
         if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3))  {          if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3))  {
                 if (NULL == curp->mdoc)                  if (NULL == curp->pmdoc)
                         curp->mdoc = mdoc_init(curp);                          curp->pmdoc = mdoc_alloc
                 if (NULL == (*mdoc = curp->mdoc))                                  (&curp->regs, curp, mmsg);
                         return(0);                  assert(curp->pmdoc);
                 curp->lastmdoc = *mdoc;                  curp->mdoc = curp->pmdoc;
                 return(1);                  return;
         }          }
   
         if (NULL == curp->man)          if (NULL == curp->pman)
                 curp->man = man_init(curp);                  curp->pman = man_alloc(&curp->regs, curp, mmsg);
         if (NULL == (*man = curp->man))          assert(curp->pman);
                 return(0);          curp->man = curp->pman;
         curp->lastman = *man;  
         return(1);  
 }  }
   
   
 static int  static int
 moptions(enum intt *tflags, char *arg)  moptions(enum intt *tflags, char *arg)
 {  {
Line 513  moptions(enum intt *tflags, char *arg)
Line 967  moptions(enum intt *tflags, char *arg)
         else if (0 == strcmp(arg, "an"))          else if (0 == strcmp(arg, "an"))
                 *tflags = INTT_MAN;                  *tflags = INTT_MAN;
         else {          else {
                 warnx("bad argument: -m%s", arg);                  fprintf(stderr, "%s: Bad argument\n", arg);
                 return(0);                  return(0);
         }          }
   
         return(1);          return(1);
 }  }
   
   
 static int  static int
 toptions(enum outt *tflags, char *arg)  toptions(struct curparse *curp, char *arg)
 {  {
   
         if (0 == strcmp(arg, "ascii"))          if (0 == strcmp(arg, "ascii"))
                 *tflags = OUTT_ASCII;                  curp->outtype = OUTT_ASCII;
         else if (0 == strcmp(arg, "lint"))          else if (0 == strcmp(arg, "lint")) {
                 *tflags = OUTT_LINT;                  curp->outtype = OUTT_LINT;
                   curp->wlevel  = MANDOCLEVEL_WARNING;
           }
         else if (0 == strcmp(arg, "tree"))          else if (0 == strcmp(arg, "tree"))
                 *tflags = OUTT_TREE;                  curp->outtype = OUTT_TREE;
           else if (0 == strcmp(arg, "html"))
                   curp->outtype = OUTT_HTML;
           else if (0 == strcmp(arg, "xhtml"))
                   curp->outtype = OUTT_XHTML;
           else if (0 == strcmp(arg, "ps"))
                   curp->outtype = OUTT_PS;
           else if (0 == strcmp(arg, "pdf"))
                   curp->outtype = OUTT_PDF;
         else {          else {
                 warnx("bad argument: -T%s", arg);                  fprintf(stderr, "%s: Bad argument\n", arg);
                 return(0);                  return(0);
         }          }
   
         return(1);          return(1);
 }  }
   
   
 /*  
  * Parse out the options for [-fopt...] setting compiler options.  These  
  * can be comma-delimited or called again.  
  */  
 static int  static int
 foptions(int *fflags, char *arg)  woptions(struct curparse *curp, char *arg)
 {  {
         char            *v;          char            *v, *o;
         char            *toks[5];          const char      *toks[6];
   
         toks[0] = "ign-scope";          toks[0] = "stop";
         toks[1] = "ign-escape";          toks[1] = "all";
         toks[2] = "ign-macro";          toks[2] = "warning";
         toks[3] = "no-ign-macro";  
         toks[4] = NULL;  
   
         while (*arg)  
                 switch (getsubopt(&arg, toks, &v)) {  
                 case (0):  
                         *fflags |= IGN_SCOPE;  
                         break;  
                 case (1):  
                         *fflags |= IGN_ESCAPE;  
                         break;  
                 case (2):  
                         *fflags |= IGN_MACRO;  
                         break;  
                 case (3):  
                         *fflags |= NO_IGN_MACRO;  
                         break;  
                 default:  
                         warnx("bad argument: -f%s", arg);  
                         return(0);  
                 }  
   
         return(1);  
 }  
   
   
 /*  
  * Parse out the options for [-Werr...], which sets warning modes.  
  * These can be comma-delimited or called again.  
  */  
 static int  
 woptions(int *wflags, char *arg)  
 {  
         char            *v;  
         char            *toks[5];  
   
         toks[0] = "all";  
         toks[1] = "compat";  
         toks[2] = "syntax";  
         toks[3] = "error";          toks[3] = "error";
         toks[4] = NULL;          toks[4] = "fatal";
           toks[5] = NULL;
   
         while (*arg)          while (*arg) {
                 switch (getsubopt(&arg, toks, &v)) {                  o = arg;
                   switch (getsubopt(&arg, UNCONST(toks), &v)) {
                 case (0):                  case (0):
                         *wflags |= WARN_WALL;                          curp->wstop = 1;
                         break;                          break;
                 case (1):                  case (1):
                         *wflags |= WARN_WCOMPAT;                          /* FALLTHROUGH */
                         break;  
                 case (2):                  case (2):
                         *wflags |= WARN_WSYNTAX;                          curp->wlevel = MANDOCLEVEL_WARNING;
                         break;                          break;
                 case (3):                  case (3):
                         *wflags |= WARN_WERR;                          curp->wlevel = MANDOCLEVEL_ERROR;
                         break;                          break;
                   case (4):
                           curp->wlevel = MANDOCLEVEL_FATAL;
                           break;
                 default:                  default:
                         warnx("bad argument: -W%s", arg);                          fprintf(stderr, "-W%s: Bad argument\n", o);
                         return(0);                          return(0);
                 }                  }
           }
   
         return(1);          return(1);
 }  }
   
   
 /* ARGSUSED */  
 static int  static int
 merr(void *arg, int line, int col, const char *msg)  mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg)
 {  {
         struct curparse *curp;          struct curparse *cp;
           enum mandoclevel level;
   
         curp = (struct curparse *)arg;          level = MANDOCLEVEL_FATAL;
           while (t < mandoclimits[level])
                   /* LINTED */
                   level--;
   
         warnx("%s:%d: error: %s (column %d)",          cp = (struct curparse *)arg;
                         curp->file, line, msg, col);          if (level < cp->wlevel)
         return(0);  
 }  
   
   
 static int  
 mdocwarn(void *arg, int line, int col,  
                 enum mdoc_warn type, const char *msg)  
 {  
         struct curparse *curp;  
         char            *wtype;  
   
         curp = (struct curparse *)arg;  
         wtype = NULL;  
   
         switch (type) {  
         case (WARN_COMPAT):  
                 wtype = "compat";  
                 if (curp->wflags & WARN_WCOMPAT)  
                         break;  
                 return(1);                  return(1);
         case (WARN_SYNTAX):  
                 wtype = "syntax";  
                 if (curp->wflags & WARN_WSYNTAX)  
                         break;  
                 return(1);  
         }  
   
         assert(wtype);          fprintf(stderr, "%s:%d:%d: %s: %s",
         warnx("%s:%d: %s warning: %s (column %d)",              cp->file, ln, col + 1, mandoclevels[level], mandocerrs[t]);
                         curp->file, line, wtype, msg, col);          if (msg)
                   fprintf(stderr, ": %s", msg);
           fputc('\n', stderr);
   
         if ( ! (curp->wflags & WARN_WERR))          if (file_status < level)
                 return(1);                  file_status = level;
   
         warnx("%s: considering warnings as errors",          return(level < MANDOCLEVEL_FATAL);
                         __progname);  
         return(0);  
 }  
   
   
 static int  
 manwarn(void *arg, int line, int col, const char *msg)  
 {  
         struct curparse *curp;  
   
         curp = (struct curparse *)arg;  
   
         if ( ! (curp->wflags & WARN_WSYNTAX))  
                 return(1);  
   
         warnx("%s:%d: syntax warning: %s (column %d)",  
                         curp->file, line, msg, col);  
   
         if ( ! (curp->wflags & WARN_WERR))  
                 return(1);  
   
         warnx("%s: considering warnings as errors",  
                         __progname);  
         return(0);  
 }  }
Legend:
Removed from v.1.23  
changed lines
  Added in v.1.147
CVSweb