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

Diff for /mandoc/main.c between version 1.6 and 1.160

version 1.6, 2009/03/20 21:29:29 version 1.160, 2011/03/28 21:49:42
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.  
  */   */
 #include <sys/stat.h>  #ifdef HAVE_CONFIG_H
   #include "config.h"
   #endif
   
 #include <assert.h>  #include <assert.h>
 #include <err.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"
   
 #ifdef __linux__  #if !defined(__GNUC__) || (__GNUC__ < 2)
 extern  int               getsubopt(char **, char * const *, char **);  # if !defined(lint)
 # ifndef __dead  #  define __attribute__(x)
 #  define __dead __attribute__((__noreturn__))  
 # endif  # endif
 #endif  #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
   
 struct  buf {  typedef void            (*out_mdoc)(void *, const struct mdoc *);
         char             *buf;  typedef void            (*out_man)(void *, const struct man *);
         size_t            sz;  typedef void            (*out_free)(void *);
   
   enum    outt {
           OUTT_ASCII = 0, /* -Tascii */
           OUTT_TREE,      /* -Ttree */
           OUTT_HTML,      /* -Thtml */
           OUTT_XHTML,     /* -Txhtml */
           OUTT_LINT,      /* -Tlint */
           OUTT_PS,        /* -Tps */
           OUTT_PDF        /* -Tpdf */
 };  };
   
 struct  curparse {  struct  curparse {
         const char       *file;          struct mparse    *mp;
         int               wflags;          enum mandoclevel  wlevel;       /* ignore messages below this */
 #define WARN_WALL         0x03          /* All-warnings mask. */          int               wstop;        /* stop after a file with a warning */
 #define WARN_WCOMPAT     (1 << 0)       /* Compatibility warnings. */          enum outt         outtype;      /* which output to use */
 #define WARN_WSYNTAX     (1 << 1)       /* Syntax warnings. */          out_mdoc          outmdoc;      /* mdoc output ptr */
 #define WARN_WERR        (1 << 2)       /* Warnings->errors. */          out_man           outman;       /* man output ptr */
           out_free          outfree;      /* free output ptr */
           void             *outdata;      /* data for output */
           char              outopts[BUFSIZ]; /* buf of output opts */
 };  };
   
 enum outt {  static  int               moptions(enum mparset *, char *);
         OUTT_ASCII,  static  void              mmsg(enum mandocerr, enum mandoclevel,
         OUTT_LATIN1,                                  const char *, int, int, const char *);
         OUTT_UTF8,  static  void              parse(struct curparse *, int,
         OUTT_TREE,                                  const char *, enum mandoclevel *);
         OUTT_LINT  static  int               toptions(struct curparse *, char *);
 };  static  void              usage(void) __attribute__((noreturn));
   static  void              version(void) __attribute__((noreturn));
   static  int               woptions(struct curparse *, char *);
   
 typedef int             (*out_run)(void *, const struct mdoc *);  static  const char       *progname;
 typedef void            (*out_free)(void *);  
   
 extern  char             *__progname;  
   
 extern  void             *ascii_alloc(void);  
 extern  void             *latin1_alloc(void);  
 extern  void             *utf8_alloc(void);  
 extern  int               terminal_run(void *, const struct mdoc *);  
 extern  int               tree_run(void *, const struct mdoc *);  
 extern  void              terminal_free(void *);  
   
 __dead  static void       version(void);  
 __dead  static void       usage(void);  
 static  int               foptions(int *, char *);  
 static  int               toptions(enum outt *, char *);  
 static  int               woptions(int *, char *);  
 static  int               merr(void *, int, int, const char *);  
 static  int               mwarn(void *, int, int,  
                                 enum mdoc_warn, const char *);  
 static  int               file(struct buf *, struct buf *,  
                                 const char *, struct mdoc *);  
 static  int               fdesc(struct buf *, struct buf *,  
                                 const char *, int, struct mdoc *);  
   
   
 int  int
 main(int argc, char *argv[])  main(int argc, char *argv[])
 {  {
         int              c, rc, fflags, wflags;          int              c;
         struct mdoc_cb   cb;  
         struct mdoc     *mdoc;  
         void            *outdata;  
         enum outt        outtype;  
         struct buf       ln, blk;  
         out_run          outrun;  
         out_free         outfree;  
         struct curparse  curp;          struct curparse  curp;
           enum mparset     type;
           enum mandoclevel rc;
   
         fflags = wflags = 0;          progname = strrchr(argv[0], '/');
         outtype = OUTT_ASCII;          if (progname == NULL)
                   progname = argv[0];
           else
                   ++progname;
   
         bzero(&curp, sizeof(struct curparse));          memset(&curp, 0, sizeof(struct curparse));
   
           type = MPARSE_AUTO;
           curp.outtype = OUTT_ASCII;
           curp.wlevel  = MANDOCLEVEL_FATAL;
   
         /* LINTED */          /* LINTED */
         while (-1 != (c = getopt(argc, argv, "f:VW:T:")))          while (-1 != (c = getopt(argc, argv, "m:O:T:VW:")))
                 switch (c) {                  switch (c) {
                 case ('f'):                  case ('m'):
                         if ( ! foptions(&fflags, optarg))                          if ( ! moptions(&type, 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 124  main(int argc, char *argv[])
Line 122  main(int argc, char *argv[])
                         /* NOTREACHED */                          /* NOTREACHED */
                 }                  }
   
           curp.mp = mparse_alloc(type, curp.wlevel, mmsg, &curp);
   
         argc -= optind;          argc -= optind;
         argv += optind;          argv += optind;
   
         /*          rc = MANDOCLEVEL_OK;
          * Allocate the appropriate front-end.  Note that utf8, ascii  
          * and latin1 all resolve to the terminal front-end with  
          * different encodings (see terminal.c).  Not all frontends have  
          * cleanup or alloc routines.  
          */  
   
         switch (outtype) {          if (NULL == *argv)
         case (OUTT_LATIN1):                  parse(&curp, STDIN_FILENO, "<stdin>", &rc);
                 outdata = latin1_alloc();  
                 outrun = terminal_run;  
                 outfree = terminal_free;  
                 break;  
         case (OUTT_UTF8):  
                 outdata = utf8_alloc();  
                 outrun = terminal_run;  
                 outfree = terminal_free;  
                 break;  
         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;  
         }  
   
         /*          while (*argv) {
          * All callbacks route into here, where we print them onto the                  parse(&curp, -1, *argv, &rc);
          * screen.  XXX - for now, no path for debugging messages.                  if (MANDOCLEVEL_OK != rc && curp.wstop)
          */                          break;
                   ++argv;
         cb.mdoc_msg = NULL;  
         cb.mdoc_err = merr;  
         cb.mdoc_warn = mwarn;  
   
         bzero(&ln, sizeof(struct buf));  
         bzero(&blk, sizeof(struct buf));  
   
         mdoc = mdoc_alloc(&curp, fflags, &cb);  
   
         /*  
          * Loop around available files.  
          */  
   
         if (NULL == *argv) {  
                 curp.file = "<stdin>";  
                 c = fdesc(&blk, &ln, "stdin", STDIN_FILENO, mdoc);  
                 rc = 0;  
                 if (c && NULL == outrun)  
                         rc = 1;  
                 else if (c && outrun && (*outrun)(outdata, mdoc))  
                         rc = 1;  
         } else {  
                 while (*argv) {  
                         curp.file = *argv;  
                         c = file(&blk, &ln, *argv, mdoc);  
                         if ( ! c)  
                                 break;  
                         if (outrun && ! (*outrun)(outdata, mdoc))  
                                 break;  
                         /* Reset the parser for another file. */  
                         mdoc_reset(mdoc);  
                         argv++;  
                 }  
                 rc = NULL == *argv;  
         }          }
   
         if (blk.buf)          if (curp.outfree)
                 free(blk.buf);                  (*curp.outfree)(curp.outdata);
         if (ln.buf)          if (curp.mp)
                 free(ln.buf);                  mparse_free(curp.mp);
         if (outfree)  
                 (*outfree)(outdata);  
   
         mdoc_free(mdoc);          return((int)rc);
   
         return(rc ? EXIT_SUCCESS : EXIT_FAILURE);  
 }  }
   
   static void
 __dead static void  
 version(void)  version(void)
 {  {
   
         (void)printf("%s %s\n", __progname, VERSION);          printf("%s %s\n", progname, VERSION);
         exit(0);          exit((int)MANDOCLEVEL_OK);
         /* NOTREACHED */  
 }  }
   
   static void
 __dead static void  
 usage(void)  usage(void)
 {  {
   
         (void)fprintf(stderr, "usage: %s\n", __progname);          fprintf(stderr, "usage: %s "
         exit(1);                          "[-V] "
         /* NOTREACHED */                          "[-foption] "
                           "[-mformat] "
                           "[-Ooption] "
                           "[-Toutput] "
                           "[-Werr] "
                           "[file...]\n",
                           progname);
   
           exit((int)MANDOCLEVEL_BADARG);
 }  }
   
   static void
 static int  parse(struct curparse *curp, int fd,
 file(struct buf *blk, struct buf *ln,                  const char *file, enum mandoclevel *level)
                 const char *file, struct mdoc *mdoc)  
 {  {
         int              fd, c;          enum mandoclevel  rc;
           struct mdoc      *mdoc;
           struct man       *man;
   
         if (-1 == (fd = open(file, O_RDONLY, 0))) {          /* Begin by parsing the file itself. */
                 warn("%s", file);  
                 return(0);  
         }  
   
         c = fdesc(blk, ln, file, fd, mdoc);          assert(file);
           assert(fd >= -1);
   
         if (-1 == close(fd))          rc = mparse_readfd(curp->mp, fd, file);
                 warn("%s", file);  
   
         return(c);          /* Stop immediately if the parse has failed. */
 }  
   
           if (MANDOCLEVEL_FATAL <= rc)
                   goto cleanup;
   
 static int  
 fdesc(struct buf *blk, struct buf *ln,  
                 const char *f, int fd, struct mdoc *mdoc)  
 {  
         size_t           sz;  
         ssize_t          ssz;  
         struct stat      st;  
         int              j, i, pos, lnn;  
   
         /*          /*
          * Two buffers: ln and buf.  buf is the input buffer, optimised           * With -Wstop and warnings or errors of at least the requested
          * for each file's block size.  ln is a line buffer.  Both           * level, do not produce output.
          * growable, hence passed in by ptr-ptr.  
          */           */
   
         sz = BUFSIZ;          if (MANDOCLEVEL_OK != rc && curp->wstop)
                   goto cleanup;
   
         if (-1 == fstat(fd, &st))          /* If unset, allocate output dev now (if applicable). */
                 warnx("%s", f);  
         else if ((size_t)st.st_blksize > sz)  
                 sz = st.st_blksize;  
   
         if (sz > blk->sz) {          if ( ! (curp->outman && curp->outmdoc)) {
                 blk->buf = realloc(blk->buf, sz);                  switch (curp->outtype) {
                 if (NULL == blk->buf)                  case (OUTT_XHTML):
                         err(1, "realloc");                          curp->outdata = xhtml_alloc(curp->outopts);
                 blk->sz = sz;                          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) {
          * Fill buf with file blocksize and parse newlines into ln.                  case (OUTT_HTML):
          */                          /* FALLTHROUGH */
                   case (OUTT_XHTML):
         for (lnn = 1, pos = 0; ; ) {                          curp->outman = html_man;
                 if (-1 == (ssz = read(fd, blk->buf, sz))) {                          curp->outmdoc = html_mdoc;
                         warn("%s", f);                          curp->outfree = html_free;
                         return(0);  
                 } else if (0 == ssz)  
                         break;                          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;
                   }
           }
   
                 for (i = 0; i < (int)ssz; i++) {          mparse_result(curp->mp, &mdoc, &man);
                         if (pos >= (int)ln->sz) {  
                                 ln->sz += 256; /* Step-size. */  
                                 ln->buf = realloc(ln->buf, ln->sz);  
                                 if (NULL == ln->buf)  
                                         err(1, "realloc");  
                         }  
   
                         if ('\n' != blk->buf[i]) {          /* Execute the out device, if it exists. */
                                 ln->buf[pos++] = blk->buf[i];  
                                 continue;  
                         }  
   
                         /* Check for CPP-escaped newline.  */          if (man && curp->outman)
                   (*curp->outman)(curp->outdata, man);
           if (mdoc && curp->outmdoc)
                   (*curp->outmdoc)(curp->outdata, mdoc);
   
                         if (pos > 0 && '\\' == ln->buf[pos - 1]) {   cleanup:
                                 for (j = pos - 1; j >= 0; j--)  
                                         if ('\\' != ln->buf[j])  
                                                 break;  
   
                                 if ( ! ((pos - j) % 2)) {          mparse_reset(curp->mp);
                                         pos--;  
                                         lnn++;  
                                         continue;  
                                 }  
                         }  
   
                         ln->buf[pos] = 0;          if (*level < rc)
                         if ( ! mdoc_parseln(mdoc, lnn, ln->buf))                  *level = rc;
                                 return(0);  
                         lnn++;  
                         pos = 0;  
                 }  
         }  
   
         return(mdoc_endparse(mdoc));  
 }  }
   
   
 static int  static int
 toptions(enum outt *tflags, char *arg)  moptions(enum mparset *tflags, char *arg)
 {  {
   
         if (0 == strcmp(arg, "ascii"))          if (0 == strcmp(arg, "doc"))
                 *tflags = OUTT_ASCII;                  *tflags = MPARSE_MDOC;
         else if (0 == strcmp(arg, "latin1"))          else if (0 == strcmp(arg, "andoc"))
                 *tflags = OUTT_LATIN1;                  *tflags = MPARSE_AUTO;
         else if (0 == strcmp(arg, "utf8"))          else if (0 == strcmp(arg, "an"))
                 *tflags = OUTT_UTF8;                  *tflags = MPARSE_MAN;
         else if (0 == strcmp(arg, "lint"))  
                 *tflags = OUTT_LINT;  
         else if (0 == strcmp(arg, "tree"))  
                 *tflags = OUTT_TREE;  
         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)  toptions(struct curparse *curp, char *arg)
 {  {
         char            *v;  
         char            *toks[4];  
   
         toks[0] = "ign-scope";          if (0 == strcmp(arg, "ascii"))
         toks[1] = "ign-escape";                  curp->outtype = OUTT_ASCII;
         toks[2] = "ign-macro";          else if (0 == strcmp(arg, "lint")) {
         toks[3] = NULL;                  curp->outtype = OUTT_LINT;
                   curp->wlevel  = MANDOCLEVEL_WARNING;
           } else if (0 == strcmp(arg, "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 {
                   fprintf(stderr, "%s: Bad argument\n", arg);
                   return(0);
           }
   
         while (*arg)  
                 switch (getsubopt(&arg, toks, &v)) {  
                 case (0):  
                         *fflags |= MDOC_IGN_SCOPE;  
                         break;  
                 case (1):  
                         *fflags |= MDOC_IGN_ESCAPE;  
                         break;  
                 case (2):  
                         *fflags |= MDOC_IGN_MACRO;  
                         break;  
                 default:  
                         warnx("bad argument: -f%s", arg);  
                         return(0);  
                 }  
   
         return(1);          return(1);
 }  }
   
   
 /*  
  * Parse out the options for [-Werr...], which sets warning modes.  
  * These can be comma-delimited or called again.  
  */  
 static int  static int
 woptions(int *wflags, char *arg)  woptions(struct curparse *curp, char *arg)
 {  {
         char            *v;          char            *v, *o;
         char            *toks[5];          const char      *toks[6];
   
         toks[0] = "all";          toks[0] = "stop";
         toks[1] = "compat";          toks[1] = "all";
         toks[2] = "syntax";          toks[2] = "warning";
         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);
 }  }
   
   static void
 /* ARGSUSED */  mmsg(enum mandocerr t, enum mandoclevel lvl,
 static int                  const char *file, int line, int col, const char *msg)
 merr(void *arg, int line, int col, const char *msg)  
 {  {
         struct curparse *curp;  
   
         curp = (struct curparse *)arg;          fprintf(stderr, "%s:%d:%d: %s: %s",
                           file, line, col + 1,
                           mparse_strlevel(lvl),
                           mparse_strerror(t));
   
         warnx("%s:%d: error: %s (column %d)",          if (msg)
                         curp->file, line, msg, col);                  fprintf(stderr, ": %s", msg);
         return(0);  
 }  
   
           fputc('\n', stderr);
 static int  
 mwarn(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);  
         case (WARN_SYNTAX):  
                 wtype = "syntax";  
                 if (curp->wflags & WARN_WSYNTAX)  
                         break;  
                 return(1);  
         }  
   
         assert(wtype);  
         warnx("%s:%d: %s warning: %s (column %d)",  
                         curp->file, line, wtype, msg, col);  
   
         if ( ! (curp->wflags & WARN_WERR))  
                 return(1);  
   
         warnx("%s: considering warnings as errors",  
                         __progname);  
         return(0);  
 }  }
   
   
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.160
CVSweb