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

Diff for /mandoc/main.c between version 1.20 and 1.114

version 1.20, 2009/04/02 16:37:40 version 1.114, 2010/12/01 17:00:05
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010 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 UNCONST(a)      ((void *)(uintptr_t)(const void *)(a))
 extern  int               getsubopt(char **, char * const *, char **);  
 # ifndef __dead  /* FIXME: Intel's compiler?  LLVM?  pcc?  */
 #  define __dead __attribute__((__noreturn__))  
   #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 void            (*out_mdoc)(void *, const struct mdoc *);
   typedef void            (*out_man)(void *, const struct man *);
   typedef void            (*out_free)(void *);
   
 struct  buf {  struct  buf {
         char             *buf;          char             *buf;
         size_t            sz;          size_t            sz;
Line 56  enum intt {
Line 69  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;          const char       *file;         /* Current parse. */
         int               fd;          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 */
         enum intt         inttype;          struct man       *man;          /* man parser */
         struct man       *man;          struct mdoc      *mdoc;         /* mdoc parser */
         struct mdoc      *mdoc;          struct roff      *roff;         /* roff parser (!NULL) */
           struct regset     regs;         /* roff registers */
           enum outt         outtype;      /* which output to use */
           out_mdoc          outmdoc;      /* mdoc output ptr */
           out_man           outman;       /* man output ptr */
           out_free          outfree;      /* free output ptr */
           void             *outdata;      /* data for output */
           char              outopts[BUFSIZ]; /* buf of output opts */
 };  };
   
 #define IGN_SCOPE        (1 << 0)       /* Ignore scope errors. */  static  const char * const      mandoclevels[MANDOCLEVEL_MAX] = {
 #define IGN_ESCAPE       (1 << 1)       /* Ignore bad escapes. */          "SUCCESS",
 #define IGN_MACRO        (1 << 2)       /* Ignore unknown macros. */          "RESERVED",
 #define NO_IGN_MACRO     (1 << 3)          "WARNING",
           "ERROR",
           "FATAL",
           "BADARG",
           "SYSERR"
   };
   
 typedef int             (*out_run)(void *, const struct man *,  static  const enum mandocerr    mandoclimits[MANDOCLEVEL_MAX] = {
                                 const struct mdoc *);          MANDOCERR_OK,
 typedef void            (*out_free)(void *);          MANDOCERR_WARNING,
           MANDOCERR_WARNING,
           MANDOCERR_ERROR,
           MANDOCERR_FATAL,
           MANDOCERR_MAX,
           MANDOCERR_MAX
   };
   
 extern  char             *__progname;  static  const char * const      mandocerrs[MANDOCERR_MAX] = {
           "ok",
   
 extern  void             *ascii_alloc(void);          "generic warning",
 extern  int               terminal_run(void *, const struct man *,  
                                 const struct mdoc *);  
 extern  int               tree_run(void *, const struct man *,  
                                 const struct mdoc *);  
 extern  void              terminal_free(void *);  
   
 static  int               foptions(int *, char *);          ".so is fragile, better use ln(1)",
 static  int               toptions(enum outt *, char *);          "text should be uppercase",
           "sections out of conventional order",
           "section name repeats",
           "out of order prologue",
           "repeated prologue entry",
           "list type must come first",
           "tab in non-literal context",
           "bad escape sequence",
           "unterminated quoted string",
           "argument requires the width argument",
           "superfluous width argument",
           "bad date argument",
           "bad width argument",
           "unknown manual section",
           "section not in conventional manual section",
           "end of line whitespace",
           "blocks badly nested",
   
           "generic error",
   
           "NAME section must come first",
           "bad Boolean value",
           "child violates parent syntax",
           "bad AT&T symbol",
           "bad standard",
           "list type repeated",
           "display type repeated",
           "argument repeated",
           "ignoring argument",
           "manual name not yet set",
           "obsolete macro ignored",
           "empty macro ignored",
           "macro not allowed in body",
           "macro not allowed in prologue",
           "bad character",
           "bad NAME section contents",
           "no blank lines",
           "no text in this context",
           "bad comment style",
           "unknown macro will be lost",
           "NOT IMPLEMENTED: skipping request",
           "line scope broken",
           "argument count wrong",
           "request scope close w/none open",
           "scope already open",
           "scope open on exit",
           "macro requires line argument(s)",
           "macro requires body argument(s)",
           "macro requires argument(s)",
           "no title in document",
           "missing list type",
           "missing display type",
           "missing font type",
           "line argument(s) will be lost",
           "body argument(s) will be lost",
           "paragraph macro ignored",
   
           "generic fatal error",
   
           "column syntax is inconsistent",
           "displays may not be nested",
           "unsupported display type",
           "blocks badly nested",
           "no such block is open",
           "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",
           "utsname system call failed",
           "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               moptions(enum intt *, char *);
 static  int               woptions(int *, char *);  static  int               mmsg(enum mandocerr, void *,
 static  int               merr(void *, int, int, const char *);                                  int, int, const char *);
 static  int               manwarn(void *, int, int, const char *);  static  void              pset(const char *, int, struct curparse *);
 static  int               mdocwarn(void *, int, int,  static  int               toptions(struct curparse *, char *);
                                 enum mdoc_warn, const char *);  static  void              usage(void) __attribute__((noreturn));
 static  int               fstdin(struct buf *, struct buf *,  static  void              version(void) __attribute__((noreturn));
                                 struct curparse *);  static  int               woptions(struct curparse *, char *);
 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 *, size_t, 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);  
   
   static  const char       *progname;
   static  enum mandoclevel  exit_status = MANDOCLEVEL_OK;
   
 int  int
 main(int argc, char *argv[])  main(int argc, char *argv[])
 {  {
         int              c, rc;          int              c;
         void            *outdata;  
         enum outt        outtype;  
         struct buf       ln, blk;  
         out_run          outrun;  
         out_free         outfree;  
         struct curparse  curp;          struct curparse  curp;
   
         outtype = OUTT_ASCII;          progname = strrchr(argv[0], '/');
           if (progname == NULL)
                   progname = argv[0];
           else
                   ++progname;
   
         bzero(&curp, sizeof(struct curparse));          memset(&curp, 0, sizeof(struct curparse));
   
         curp.inttype = INTT_AUTO;          curp.inttype = INTT_AUTO;
           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(&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 160  main(int argc, char *argv[])
Line 263  main(int argc, char *argv[])
         argc -= optind;          argc -= optind;
         argv += optind;          argv += optind;
   
         /*          if (NULL == *argv) {
          * Allocate the appropriate front-end.  Note that utf8, latin1                  curp.file = "<stdin>";
          * (both not yet implemented) and ascii all resolve to the                  curp.fd = STDIN_FILENO;
          * terminal front-end with different encodings (see terminal.c).  
          * Not all frontends have cleanup or alloc routines.  
          */  
   
         switch (outtype) {                  fdesc(&curp);
         case (OUTT_TREE):  
                 outdata = NULL;  
                 outrun = tree_run;  
                 outfree = NULL;  
                 break;  
         case (OUTT_LINT):  
                 outdata = NULL;  
                 outrun = NULL;  
                 outfree = NULL;  
                 break;  
         default:  
                 outdata = ascii_alloc();  
                 outrun = terminal_run;  
                 outfree = terminal_free;  
                 break;  
         }          }
   
         /* Configure buffers. */          while (*argv) {
                   ffile(*argv, &curp);
         bzero(&ln, sizeof(struct buf));                  if (MANDOCLEVEL_OK != exit_status && curp.wstop)
         bzero(&blk, sizeof(struct buf));                          break;
                   ++argv;
         /*  
          * Main loop around available files.  
          */  
   
         if (NULL == *argv) {  
                 rc = 0;  
                 c = fstdin(&blk, &ln, &curp);  
   
                 if (c && NULL == outrun)  
                         rc = 1;  
                 /*else if (c && outrun && (*outrun)(outdata, curp.man, curp.mdoc))  
                         rc = 1;*/  
         } else {  
                 while (*argv) {  
                         c = ffile(&blk, &ln, *argv, &curp);  
                         if ( ! c)  
                                 break;  
                         /*if (outrun && ! (*outrun)(outdata, curp.man, curp.mdoc))  
                                 break;*/  
                         if (curp.man)  
                                 man_reset(curp.man);  
                         if (curp.mdoc && ! mdoc_reset(curp.mdoc)) {  
                                 warnx("memory exhausted");  
                                 break;  
                         }  
                         argv++;  
                 }  
                 rc = NULL == *argv;  
         }          }
   
         if (blk.buf)          if (curp.outfree)
                 free(blk.buf);                  (*curp.outfree)(curp.outdata);
         if (ln.buf)          if (curp.pmdoc)
                 free(ln.buf);                  mdoc_free(curp.pmdoc);
         if (outfree)          if (curp.pman)
                 (*outfree)(outdata);                  man_free(curp.pman);
         if (curp.mdoc)          if (curp.roff)
                 mdoc_free(curp.mdoc);                  roff_free(curp.roff);
         if (curp.man)  
                 man_free(curp.man);  
   
         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().
            */
   
         /* Set command defaults. */          curp->file = file;
         pflags = MAN_IGN_MACRO;  
   
         if (curp->fflags & IGN_MACRO)          if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {
                 pflags |= MAN_IGN_MACRO;                  perror(curp->file);
         if (curp->fflags & NO_IGN_MACRO)                  exit_status = MANDOCLEVEL_SYSERR;
                 pflags &= ~MAN_IGN_MACRO;                  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;                  exit_status = MANDOCLEVEL_SYSERR;
                   return(0);
           }
   
         pflags = 0;          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);
   
           return(MANDOCLEVEL_FATAL > exit_status ? 1 : 0);
 }  }
   
   
 static int  static void
 fstdin(struct buf *blk, struct buf *ln, struct curparse *curp)  resize_buf(struct buf *buf, size_t initial)
 {  {
   
         curp->file = "<stdin>";          buf->sz = buf->sz ? 2 * buf->sz : initial;
         curp->fd = STDIN_FILENO;          buf->buf = realloc(buf->buf, buf->sz);
         return(fdesc(blk, ln, curp));          if (NULL == buf->buf) {
                   perror(NULL);
                   exit((int)MANDOCLEVEL_SYSERR);
           }
 }  }
   
   
 static int  static int
 ffile(struct buf *blk, struct buf *ln,  read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap)
                 const char *file, struct curparse *curp)  
 {  {
         int              c;          struct stat      st;
           size_t           off;
           ssize_t          ssz;
   
         curp->file = file;          if (-1 == fstat(curp->fd, &st)) {
         if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {                  perror(curp->file);
                 warn("%s", curp->file);  
                 return(0);                  return(0);
         }          }
   
         c = fdesc(blk, ln, curp);          /*
            * If we're a regular file, try just reading in the whole entry
            * via mmap().  This is faster than reading it into blocks, and
            * 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 == close(curp->fd))          if (S_ISREG(st.st_mode)) {
                 warn("%s", curp->file);                  if (st.st_size >= (1U << 31)) {
                           fprintf(stderr, "%s: input too large\n",
                                           curp->file);
                           return(0);
                   }
                   *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);
           }
   
         return(c);          /*
            * 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.
            */
   
           *with_mmap = 0;
           off = 0;
           fb->sz = 0;
           fb->buf = NULL;
           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;
                   }
                   off += (size_t)ssz;
           }
   
           free(fb->buf);
           fb->buf = NULL;
           return(0);
 }  }
   
   
 static int  static void
 fdesc(struct buf *blk, struct buf *ln, struct curparse *curp)  fdesc(struct curparse *curp)
 {  {
         size_t           sz;  
         ssize_t          ssz;  
         struct stat      st;  
         int              j, i, pos, lnn;  
         struct man      *man;  
         struct mdoc     *mdoc;  
   
         sz = BUFSIZ;          /*
         man = NULL;           * Called once per file with an opened file descriptor.  All
         mdoc = NULL;           * 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.
            */
   
           /* Zero the parse type. */
   
           curp->mdoc = NULL;
           curp->man = NULL;
   
           /* Make sure the mandotory roff parser is initialised. */
   
           if (NULL == curp->roff) {
                   curp->roff = roff_alloc(&curp->regs, curp, mmsg);
                   assert(curp->roff);
           }
   
           /* Fully parse the file. */
   
           pdesc(curp);
   
           if (MANDOCLEVEL_FATAL <= exit_status)
                   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);
                   exit_status = MANDOCLEVEL_FATAL;
                   goto cleanup;
           }
   
           /* Clean up the parse routine ASTs. */
   
           if (curp->mdoc && ! mdoc_endparse(curp->mdoc)) {
                   assert(MANDOCLEVEL_FATAL <= exit_status);
                   goto cleanup;
           }
   
           if (curp->man && ! man_endparse(curp->man)) {
                   assert(MANDOCLEVEL_FATAL <= exit_status);
                   goto cleanup;
           }
   
           assert(curp->roff);
           if ( ! roff_endparse(curp->roff)) {
                   assert(MANDOCLEVEL_FATAL <= exit_status);
                   goto cleanup;
           }
   
         /*          /*
          * Two buffers: ln and buf.  buf is the input buffer optimised           * With -Wstop and warnings or errors of at least
          * here for each file's block size.  ln is a line buffer.  Both           * the requested level, do not produce output.
          * growable, hence passed in by ptr-ptr.  
          */           */
   
         if (-1 == fstat(curp->fd, &st))          if (MANDOCLEVEL_OK != exit_status && curp->wstop)
                 warnx("%s", curp->file);                  goto cleanup;
         else if ((size_t)st.st_blksize > sz)  
                 sz = st.st_blksize;  
   
         if (sz > blk->sz) {          /* If unset, allocate output dev now (if applicable). */
                 blk->buf = realloc(blk->buf, sz);  
                 if (NULL == blk->buf) {          if ( ! (curp->outman && curp->outmdoc)) {
                         warn("realloc");                  switch (curp->outtype) {
                         return(0);                  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;
                 }                  }
                 blk->sz = sz;  
                   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):
                           curp->outman = tree_man;
                           curp->outmdoc = tree_mdoc;
                           break;
                   case (OUTT_PDF):
                           /* FALLTHROUGH */
                   case (OUTT_ASCII):
                           /* FALLTHROUGH */
                   case (OUTT_PS):
                           curp->outman = terminal_man;
                           curp->outmdoc = terminal_mdoc;
                           break;
                   default:
                           break;
                   }
         }          }
   
         /* Fill buf with file blocksize. */          /* Execute the out device, if it exists. */
   
         for (lnn = 0, pos = 0; ; ) {          if (curp->man && curp->outman)
                 if (-1 == (ssz = read(curp->fd, blk->buf, sz))) {                  (*curp->outman)(curp->outdata, curp->man);
                         warn("%s", curp->file);          if (curp->mdoc && curp->outmdoc)
                         return(0);                  (*curp->outmdoc)(curp->outdata, curp->mdoc);
                 } else if (0 == ssz)  
    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);
   
           return;
   }
   
   static void
   pdesc(struct curparse *curp)
   {
           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(curp, &blk, &with_mmap)) {
                   exit_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)
   {
           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;                          break;
   
                 /* Parse the read block into partial or full lines. */                  if (start)
                           curp->line = lnn;
   
                 for (i = 0; i < (int)ssz; i++) {                  while (i < (int)blk.sz && (start || '\0' != blk.buf[i])) {
                         if (pos >= (int)ln->sz) {                          if ('\n' == blk.buf[i]) {
                                 ln->sz += 256; /* Step-size. */                                  ++i;
                                 ln->buf = realloc(ln->buf, ln->sz);                                  ++lnn;
                                 if (NULL == ln->buf) {                                  break;
                                         warn("realloc");  
                                         return(0);  
                                 }  
                         }                          }
   
                         if ('\n' != blk->buf[i]) {                          /*
                                 ln->buf[pos++] = blk->buf[i];                           * 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;                                  continue;
                         }                          }
   
                         /* Check for CPP-escaped newline.  */                          /* Trailing backslash = a plain char. */
   
                         if (pos > 0 && '\\' == ln->buf[pos - 1]) {                          if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {
                                 for (j = pos - 1; j >= 0; j--)                                  if (pos >= (int)ln.sz)
                                         if ('\\' != ln->buf[j])                                          resize_buf(&ln, 256);
                                   ln.buf[pos++] = blk.buf[i++];
                                   continue;
                           }
   
                           /* Found escape & at least one other char. */
   
                           if ('\n' == blk.buf[i + 1]) {
                                   i += 2;
                                   /* Escaped newlines are skipped over */
                                   ++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;                                                  break;
                                           }
                                   }
   
                                 if ( ! ((pos - j) % 2)) {                                  /* Backout trailing whitespaces */
                                         pos--;                                  for (; pos > 0; --pos) {
                                         lnn++;                                          if (ln.buf[pos - 1] != ' ')
                                         continue;                                                  break;
                                           if (pos > 2 && ln.buf[pos - 2] == '\\')
                                                   break;
                                 }                                  }
                                   break;
                         }                          }
   
                         ln->buf[pos] = 0;                          /* Some other escape sequence, copy & cont. */
                         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 (pos + 1 >= (int)ln.sz)
                                                 pos, curp, &man, &mdoc))                                  resize_buf(&ln, 256);
                                 return(0);  
   
                           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):
                           parsebuf(curp, ln, 0);
                         pos = 0;                          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 <= exit_status);
                           break;
                   case (ROFF_SO):
                           if (pfile(ln.buf + of, curp)) {
                                   pos = 0;
                                   continue;
                           } else
                                   break;
                   case (ROFF_CONT):
                           break;
                   }
   
                         if (man && ! man_parseln(man, lnn, ln->buf))                  /*
                                 return(0);                   * If input parsers have not been allocated, do so now.
                         if (mdoc && ! mdoc_parseln(mdoc, lnn, ln->buf))                   * We keep these instanced betwen parsers, but set them
                                 return(0);                   * 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 (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 ( ! rc) {
                                   assert(MANDOCLEVEL_FATAL <= exit_status);
                                   break;
                           }
                 }                  }
         }  
   
         /* Note that a parser may not have been assigned, yet. */                  /* Temporary buffers typically are not full. */
   
         if (mdoc)                  if (0 == start && '\0' == blk.buf[i])
                return(mdoc_endparse(mdoc));                          break;
         if (man)  
                 return(man_endparse(man));  
   
         warnx("%s: not a manual", curp->file);                  /* Start the next input line. */
         return(0);  
 }  
   
                   pos = 0;
           }
   
 static int          free(ln.buf);
 pset(const char *buf, size_t pos, struct curparse *curp,  }
                 struct man **man, struct mdoc **mdoc)  
   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);
                 warnx("inheriting -mdoc parser");                  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);
                 warnx("inheriting -man parser");                  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);
                 return(1);                  curp->mdoc = curp->pmdoc;
                   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;
         return(1);  
 }  }
   
   
 static int  static int
 moptions(enum intt *tflags, char *arg)  moptions(enum intt *tflags, char *arg)
 {  {
Line 509  moptions(enum intt *tflags, char *arg)
Line 885  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[4] = "no-ign-macro";          toks[3] = "error";
           toks[4] = "fatal";
         toks[5] = NULL;          toks[5] = NULL;
   
         while (*arg)          while (*arg) {
                 switch (getsubopt(&arg, toks, &v)) {                  o = arg;
                   switch (getsubopt(&arg, UNCONST(toks), &v)) {
                 case (0):                  case (0):
                         *fflags |= IGN_SCOPE;                          curp->wstop = 1;
                         break;                          break;
                 case (1):                  case (1):
                         *fflags |= IGN_ESCAPE;                          /* FALLTHROUGH */
                         break;  
                 case (2):                  case (2):
                         *fflags |= IGN_MACRO;                          curp->wlevel = MANDOCLEVEL_WARNING;
                         break;                          break;
                 case (3):                  case (3):
                         *fflags |= NO_IGN_MACRO;                          curp->wlevel = MANDOCLEVEL_ERROR;
                         break;                          break;
                 default:                  case (4):
                         warnx("bad argument: -f%s", arg);                          curp->wlevel = MANDOCLEVEL_FATAL;
                         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[4] = NULL;  
   
         while (*arg)  
                 switch (getsubopt(&arg, toks, &v)) {  
                 case (0):  
                         *wflags |= WARN_WALL;  
                         break;                          break;
                 case (1):  
                         *wflags |= WARN_WCOMPAT;  
                         break;  
                 case (2):  
                         *wflags |= WARN_WSYNTAX;  
                         break;  
                 case (3):  
                         *wflags |= WARN_WERR;  
                         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 (exit_status < level)
                 return(1);                  exit_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.20  
changed lines
  Added in v.1.114
CVSweb