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

Diff for /mandoc/main.c between version 1.71 and 1.188

version 1.71, 2010/05/15 18:35:14 version 1.188, 2014/08/30 18:08:10
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010, 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>
    * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
Line 14 
Line 16 
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */   */
 #ifdef HAVE_CONFIG_H  
 #include "config.h"  #include "config.h"
 #endif  
   
 #include <sys/mman.h>  #include <sys/types.h>
 #include <sys/stat.h>  
   
 #include <assert.h>  #include <assert.h>
   #include <ctype.h>
   #include <errno.h>
 #include <fcntl.h>  #include <fcntl.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdint.h>  #include <stdint.h>
Line 30 
Line 31 
 #include <unistd.h>  #include <unistd.h>
   
 #include "mandoc.h"  #include "mandoc.h"
   #include "mandoc_aux.h"
   #include "main.h"
 #include "mdoc.h"  #include "mdoc.h"
 #include "man.h"  #include "man.h"
 #include "roff.h"  #include "manpath.h"
 #include "main.h"  #include "mansearch.h"
   
 #define UNCONST(a)      ((void *)(uintptr_t)(const void *)(a))  
   
 /* FIXME: Intel's compiler?  LLVM?  pcc?  */  
   
 #if !defined(__GNUC__) || (__GNUC__ < 2)  #if !defined(__GNUC__) || (__GNUC__ < 2)
 # if !defined(lint)  # if !defined(lint)
 #  define __attribute__(x)  #  define __attribute__(x)
 # endif  # endif
 #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */  #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
   
   enum    outmode {
           OUTMODE_DEF = 0,
           OUTMODE_FLN,
           OUTMODE_LST,
           OUTMODE_ALL,
           OUTMODE_INT,
           OUTMODE_ONE
   };
   
 typedef void            (*out_mdoc)(void *, const struct mdoc *);  typedef void            (*out_mdoc)(void *, const struct mdoc *);
 typedef void            (*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 {  
         char             *buf;  
         size_t            sz;  
 };  
   
 enum    intt {  
         INTT_AUTO,  
         INTT_MDOC,  
         INTT_MAN  
 };  
   
 enum    outt {  enum    outt {
         OUTT_ASCII = 0,          OUTT_ASCII = 0, /* -Tascii */
         OUTT_TREE,          OUTT_LOCALE,    /* -Tlocale */
         OUTT_HTML,          OUTT_UTF8,      /* -Tutf8 */
         OUTT_XHTML,          OUTT_TREE,      /* -Ttree */
         OUTT_LINT          OUTT_MAN,       /* -Tman */
           OUTT_HTML,      /* -Thtml */
           OUTT_XHTML,     /* -Txhtml */
           OUTT_LINT,      /* -Tlint */
           OUTT_PS,        /* -Tps */
           OUTT_PDF        /* -Tpdf */
 };  };
   
 struct  curparse {  struct  curparse {
         const char       *file;         /* Current parse. */          struct mparse    *mp;
         int               fd;           /* Current parse. */          enum mandoclevel  wlevel;       /* ignore messages below this */
         int               wflags;          int               wstop;        /* stop after a file with a warning */
         /* FIXME: set by max error */          enum outt         outtype;      /* which output to use */
 #define WARN_WALL        (1 << 0)       /* All-warnings mask. */          out_mdoc          outmdoc;      /* mdoc output ptr */
 #define WARN_WERR        (1 << 2)       /* Warnings->errors. */          out_man           outman;       /* man output ptr */
         int               fflags;          out_free          outfree;      /* free output ptr */
 #define FL_IGN_SCOPE     (1 << 0)       /* Ignore scope errors. */          void             *outdata;      /* data for output */
 #define FL_NIGN_ESCAPE   (1 << 1)       /* Don't ignore bad escapes. */          char              outopts[BUFSIZ]; /* buf of output opts */
 #define FL_NIGN_MACRO    (1 << 2)       /* Don't ignore bad macros. */  
 #define FL_IGN_ERRORS    (1 << 4)       /* Ignore failed parse. */  
 #define FL_STRICT         FL_NIGN_ESCAPE | \  
                           FL_NIGN_MACRO  
         enum intt         inttype;      /* Input parsers... */  
         struct man       *man;  
         struct mdoc      *mdoc;  
         struct roff      *roff;  
         enum outt         outtype;      /* Output devices... */  
         out_mdoc          outmdoc;  
         out_man           outman;  
         out_free          outfree;  
         void             *outdata;  
         char              outopts[BUFSIZ];  
 };  };
   
 static  void              fdesc(struct curparse *);  static  int               moptions(int *, char *);
 static  void              ffile(const char *, struct curparse *);  static  void              mmsg(enum mandocerr, enum mandoclevel,
 static  int               foptions(int *, char *);                                  const char *, int, int, const char *);
 static  struct man       *man_init(struct curparse *);  static  void              parse(struct curparse *, int,
 static  struct mdoc      *mdoc_init(struct curparse *);                                  const char *, enum mandoclevel *);
 static  struct roff      *roff_init(struct curparse *);  static  enum mandoclevel  passthrough(const char *);
 static  int               merr(void *, int, int, const char *); /* DEPRECATED */  static  void              spawn_pager(void);
 static  int               moptions(enum intt *, char *);  
 static  int               mwarn(void *, int, int, const char *); /* DEPRECATED */  
 static  int               mmsg(enum mandocerr, void *,  
                                 int, int, const char *);  
 static  int               pset(const char *, int, struct curparse *,  
                                 struct man **, struct mdoc **);  
 static  int               toptions(struct curparse *, char *);  static  int               toptions(struct curparse *, char *);
 static  void              usage(void) __attribute__((noreturn));  static  void              usage(enum argmode) __attribute__((noreturn));
 static  void              version(void) __attribute__((noreturn));  static  void              version(void) __attribute__((noreturn));
 static  int               woptions(int *, char *);  static  int               woptions(struct curparse *, char *);
   
   static  const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
 static  const char       *progname;  static  const char       *progname;
 static  int               with_error;  
 static  int               with_warning;  
   
   
 int  int
 main(int argc, char *argv[])  main(int argc, char *argv[])
 {  {
         int              c;  
         struct curparse  curp;          struct curparse  curp;
           struct mansearch search;
           struct manpaths  paths;
           char            *conf_file, *defpaths, *auxpaths;
           char            *defos;
   #if HAVE_SQLITE3
           struct manpage  *res, *resp;
           size_t           isec, i, sz;
           int              prio, best_prio;
           char             sec;
   #endif
           enum mandoclevel rc;
           enum outmode     outmode;
           int              show_usage;
           int              use_pager;
           int              options;
           int              c;
   
         progname = strrchr(argv[0], '/');          progname = strrchr(argv[0], '/');
         if (progname == NULL)          if (progname == NULL)
Line 128  main(int argc, char *argv[])
Line 125  main(int argc, char *argv[])
         else          else
                 ++progname;                  ++progname;
   
         memset(&curp, 0, sizeof(struct curparse));          /* Search options. */
   
         curp.inttype = INTT_AUTO;          memset(&paths, 0, sizeof(struct manpaths));
           conf_file = defpaths = auxpaths = NULL;
   
           memset(&search, 0, sizeof(struct mansearch));
           search.outkey = "Nd";
   
           if (strcmp(progname, "man") == 0)
                   search.argmode = ARG_NAME;
           else if (strncmp(progname, "apropos", 7) == 0)
                   search.argmode = ARG_EXPR;
           else if (strncmp(progname, "whatis", 6) == 0)
                   search.argmode = ARG_WORD;
           else
                   search.argmode = ARG_FILE;
   
           /* Parser and formatter options. */
   
           memset(&curp, 0, sizeof(struct curparse));
         curp.outtype = OUTT_ASCII;          curp.outtype = OUTT_ASCII;
           curp.wlevel  = MANDOCLEVEL_FATAL;
           options = MPARSE_SO;
           defos = NULL;
   
         /* LINTED */          use_pager = 1;
         while (-1 != (c = getopt(argc, argv, "f:m:O:T:VW:")))          show_usage = 0;
           outmode = OUTMODE_DEF;
   
           while (-1 != (c = getopt(argc, argv, "aC:cfI:iklM:m:O:S:s:T:VW:w"))) {
                 switch (c) {                  switch (c) {
                 case ('f'):                  case 'a':
                         if ( ! foptions(&curp.fflags, optarg))                          outmode = OUTMODE_ALL;
                                 return(EXIT_FAILURE);  
                         break;                          break;
                 case ('m'):                  case 'C':
                         if ( ! moptions(&curp.inttype, optarg))                          conf_file = optarg;
                                 return(EXIT_FAILURE);  
                         break;                          break;
                 case ('O'):                  case 'c':
                           use_pager = 0;
                           break;
                   case 'f':
                           search.argmode = ARG_WORD;
                           break;
                   case 'I':
                           if (strncmp(optarg, "os=", 3)) {
                                   fprintf(stderr,
                                       "%s: -I%s: Bad argument\n",
                                       progname, optarg);
                                   return((int)MANDOCLEVEL_BADARG);
                           }
                           if (defos) {
                                   fprintf(stderr,
                                       "%s: -I%s: Duplicate argument\n",
                                       progname, optarg);
                                   return((int)MANDOCLEVEL_BADARG);
                           }
                           defos = mandoc_strdup(optarg + 3);
                           break;
                   case 'i':
                           outmode = OUTMODE_INT;
                           break;
                   case 'k':
                           search.argmode = ARG_EXPR;
                           break;
                   case 'l':
                           search.argmode = ARG_FILE;
                           outmode = OUTMODE_ALL;
                           break;
                   case 'M':
                           defpaths = optarg;
                           break;
                   case 'm':
                           auxpaths = optarg;
                           break;
                   case 'O':
                           search.outkey = optarg;
                         (void)strlcat(curp.outopts, optarg, BUFSIZ);                          (void)strlcat(curp.outopts, optarg, BUFSIZ);
                         (void)strlcat(curp.outopts, ",", BUFSIZ);                          (void)strlcat(curp.outopts, ",", BUFSIZ);
                         break;                          break;
                 case ('T'):                  case 'S':
                           search.arch = optarg;
                           break;
                   case 's':
                           search.sec = optarg;
                           break;
                   case 'T':
                         if ( ! toptions(&curp, optarg))                          if ( ! toptions(&curp, optarg))
                                 return(EXIT_FAILURE);                                  return((int)MANDOCLEVEL_BADARG);
                         break;                          break;
                 case ('W'):                  case 'W':
                         if ( ! woptions(&curp.wflags, optarg))                          if ( ! woptions(&curp, optarg))
                                 return(EXIT_FAILURE);                                  return((int)MANDOCLEVEL_BADARG);
                         break;                          break;
                 case ('V'):                  case 'w':
                           outmode = OUTMODE_FLN;
                           break;
                   case 'V':
                         version();                          version();
                         /* NOTREACHED */                          /* NOTREACHED */
                 default:                  default:
                         usage();                          show_usage = 1;
                         /* NOTREACHED */                          break;
                 }                  }
           }
   
         argc -= optind;          if (show_usage)
         argv += optind;                  usage(search.argmode);
   
         if (NULL == *argv) {          /* Postprocess options. */
                 curp.file = "<stdin>";  
                 curp.fd = STDIN_FILENO;  
   
                 fdesc(&curp);          if (outmode == OUTMODE_DEF) {
                   switch (search.argmode) {
                   case ARG_FILE:
                           outmode = OUTMODE_ALL;
                           use_pager = 0;
                           break;
                   case ARG_NAME:
                           outmode = OUTMODE_ONE;
                           break;
                   default:
                           outmode = OUTMODE_LST;
                           break;
                   }
         }          }
   
         while (*argv) {          /* Parse arguments. */
                 ffile(*argv, &curp);  
   
                 if (with_error && !(curp.fflags & FL_IGN_ERRORS))          argc -= optind;
                         break;          argv += optind;
                 ++argv;  #if HAVE_SQLITE3
         }          resp = NULL;
   #endif
   
         if (curp.outfree)          /* Quirk for a man(1) section argument without -s. */
                 (*curp.outfree)(curp.outdata);  
         if (curp.mdoc)  
                 mdoc_free(curp.mdoc);  
         if (curp.man)  
                 man_free(curp.man);  
         if (curp.roff)  
                 roff_free(curp.roff);  
   
         return((with_warning || with_error) ?          if (search.argmode == ARG_NAME &&
                         EXIT_FAILURE :  EXIT_SUCCESS);              argv[0] != NULL &&
 }              isdigit((unsigned char)argv[0][0]) &&
               (argv[0][1] == '\0' || !strcmp(argv[0], "3p"))) {
                   search.sec = argv[0];
                   argv++;
                   argc--;
           }
   
           rc = MANDOCLEVEL_OK;
   
 static void          /* man(1), whatis(1), apropos(1) */
 version(void)  
 {  
   
         (void)printf("%s %s\n", progname, VERSION);          if (search.argmode != ARG_FILE) {
         exit(EXIT_SUCCESS);  #if HAVE_SQLITE3
 }                  if (argc == 0)
                           usage(search.argmode);
   
                   /* Access the mandoc database. */
   
 static void                  manpath_parse(&paths, conf_file, defpaths, auxpaths);
 usage(void)                  mansearch_setup(1);
 {                  if( ! mansearch(&search, &paths, argc, argv, &res, &sz))
                           usage(search.argmode);
                   manpath_free(&paths);
                   resp = res;
   
         (void)fprintf(stderr, "usage: %s [-V] [-foption] "                  if (sz == 0) {
                         "[-mformat] [-Ooption] [-Toutput] "                          if (search.argmode == ARG_NAME)
                         "[-Werr] [file...]\n", progname);                                  fprintf(stderr, "%s: No entry for %s "
         exit(EXIT_FAILURE);                                      "in the manual.\n", progname, argv[0]);
 }                          rc = MANDOCLEVEL_BADARG;
                           goto out;
                   }
   
                   /*
                    * For standard man(1) and -a output mode,
                    * prepare for copying filename pointers
                    * into the program parameter array.
                    */
   
 static struct man *                  if (outmode == OUTMODE_ONE) {
 man_init(struct curparse *curp)                          argc = 1;
 {                          best_prio = 10;
         int              pflags;                  } else if (outmode == OUTMODE_ALL)
         struct man_cb    mancb;                          argc = (int)sz;
   
         mancb.man_err = merr;                  /* Iterate all matching manuals. */
         mancb.man_warn = mwarn;  
   
         /* Defaults from mandoc.1. */                  for (i = 0; i < sz; i++) {
                           if (outmode == OUTMODE_FLN)
                                   puts(res[i].file);
                           else if (outmode == OUTMODE_LST)
                                   printf("%s - %s\n", res[i].names,
                                       res[i].output == NULL ? "" :
                                       res[i].output);
                           else if (outmode == OUTMODE_ONE) {
                                   /* Search for the best section. */
                                   isec = strcspn(res[i].file, "123456789");
                                   sec = res[i].file[isec];
                                   if ('\0' == sec)
                                           continue;
                                   prio = sec_prios[sec - '1'];
                                   if (prio >= best_prio)
                                           continue;
                                   best_prio = prio;
                                   resp = res + i;
                           }
                   }
   
         pflags = MAN_IGN_MACRO | MAN_IGN_ESCAPE;                  /*
                    * For man(1), -a and -i output mode, fall through
                    * to the main mandoc(1) code iterating files
                    * and running the parsers on each of them.
                    */
   
         if (curp->fflags & FL_NIGN_MACRO)                  if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
                 pflags &= ~MAN_IGN_MACRO;                          goto out;
         if (curp->fflags & FL_NIGN_ESCAPE)  #else
                 pflags &= ~MAN_IGN_ESCAPE;                  fputs("mandoc: database support not compiled in\n",
                       stderr);
                   return((int)MANDOCLEVEL_BADARG);
   #endif
           }
   
         return(man_alloc(curp, pflags, &mancb));          /* mandoc(1) */
 }  
   
           if ( ! moptions(&options, auxpaths))
                   return((int)MANDOCLEVEL_BADARG);
   
 static struct roff *          if (use_pager && isatty(STDOUT_FILENO))
 roff_init(struct curparse *curp)                  spawn_pager();
 {  
   
         return(roff_alloc(mmsg, curp));          curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);
 }  
   
           /*
            * Conditionally start up the lookaside buffer before parsing.
            */
           if (OUTT_MAN == curp.outtype)
                   mparse_keep(curp.mp);
   
 static struct mdoc *          if (argc == 0)
 mdoc_init(struct curparse *curp)                  parse(&curp, STDIN_FILENO, "<stdin>", &rc);
 {  
         int              pflags;  
         struct mdoc_cb   mdoccb;  
   
         mdoccb.mdoc_err = merr;          while (argc) {
         mdoccb.mdoc_warn = mwarn;  #if HAVE_SQLITE3
                   if (resp != NULL) {
                           if (resp->form)
                                   parse(&curp, -1, resp->file, &rc);
                           else
                                   rc = passthrough(resp->file);
                           resp++;
                   } else
   #endif
                           parse(&curp, -1, *argv++, &rc);
                   if (MANDOCLEVEL_OK != rc && curp.wstop)
                           break;
                   argc--;
           }
   
         /* Defaults from mandoc.1. */          if (curp.outfree)
                   (*curp.outfree)(curp.outdata);
           if (curp.mp)
                   mparse_free(curp.mp);
   
         pflags = MDOC_IGN_MACRO | MDOC_IGN_ESCAPE;  #if HAVE_SQLITE3
   out:
           if (search.argmode != ARG_FILE) {
                   mansearch_free(res, sz);
                   mansearch_setup(0);
           }
   #endif
   
         if (curp->fflags & FL_IGN_SCOPE)          free(defos);
                 pflags |= MDOC_IGN_SCOPE;  
         if (curp->fflags & FL_NIGN_ESCAPE)  
                 pflags &= ~MDOC_IGN_ESCAPE;  
         if (curp->fflags & FL_NIGN_MACRO)  
                 pflags &= ~MDOC_IGN_MACRO;  
   
         return(mdoc_alloc(curp, pflags, &mdoccb));          return((int)rc);
 }  }
   
   
 static void  static void
 ffile(const char *file, struct curparse *curp)  version(void)
 {  {
   
         curp->file = file;          printf("mandoc %s\n", VERSION);
         if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {          exit((int)MANDOCLEVEL_OK);
                 perror(curp->file);  
                 with_error = 1;  
                 return;  
         }  
   
         fdesc(curp);  
   
         if (-1 == close(curp->fd))  
                 perror(curp->file);  
 }  }
   
   static void
 static int  usage(enum argmode argmode)
 resize_buf(struct buf *buf, size_t initial)  
 {  {
         void *tmp;  
         size_t sz;  
   
         if (buf->sz == 0)          switch (argmode) {
                 sz = initial;          case ARG_FILE:
         else                  fputs("usage: mandoc [-acfklV] [-Ios=name] "
                 sz = 2 * buf->sz;                      "[-mformat] [-Ooption] [-Toutput] [-Wlevel]\n"
         tmp = realloc(buf->buf, sz);                      "\t      [file ...]\n", stderr);
         if (NULL == tmp) {                  break;
                 perror(NULL);          case ARG_NAME:
                 return(0);                  fputs("usage: man [-acfhklVw] [-C file] "
                       "[-M path] [-m path] [-S arch] [-s section]\n"
                       "\t   [section] name ...\n", stderr);
                   break;
           case ARG_WORD:
                   fputs("usage: whatis [-acfklVw] [-C file] "
                       "[-M path] [-m path] [-O outkey] [-S arch]\n"
                       "\t      [-s section] name ...\n", stderr);
                   break;
           case ARG_EXPR:
                   fputs("usage: apropos [-acfklVw] [-C file] "
                       "[-M path] [-m path] [-O outkey] [-S arch]\n"
                       "\t       [-s section] expression ...\n", stderr);
                   break;
         }          }
         buf->buf = tmp;          exit((int)MANDOCLEVEL_BADARG);
         buf->sz = sz;  
         return(1);  
 }  }
   
   static void
 static int  parse(struct curparse *curp, int fd, const char *file,
 read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap)          enum mandoclevel *level)
 {  {
         struct stat      st;          enum mandoclevel  rc;
         size_t           off;          struct mdoc      *mdoc;
         ssize_t          ssz;          struct man       *man;
   
         if (-1 == fstat(curp->fd, &st)) {          /* Begin by parsing the file itself. */
                 perror(curp->file);  
                 with_error = 1;  
                 return(0);  
         }  
   
         /*          assert(file);
          * If we're a regular file, try just reading in the whole entry          assert(fd >= -1);
          * 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 (S_ISREG(st.st_mode)) {          rc = mparse_readfd(curp->mp, fd, file);
                 if (st.st_size >= (1U << 31)) {  
                         fprintf(stderr, "%s: input too large\n",  
                                         curp->file);  
                         with_error = 1;  
                         return(0);  
                 }  
                 *with_mmap = 1;  
                 fb->sz = (size_t)st.st_size;  
                 fb->buf = mmap(NULL, fb->sz, PROT_READ,  
                                 MAP_FILE, curp->fd, 0);  
                 if (fb->buf != MAP_FAILED)  
                         return(1);  
         }  
   
         /*          /* Stop immediately if the parse has failed. */
          * 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;          if (MANDOCLEVEL_FATAL <= rc)
         off = 0;                  goto cleanup;
         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;  
                         }  
                         if (! resize_buf(fb, 65536))  
                                 break;  
                 }  
                 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;  
         with_error = 1;  
         return(0);  
 }  
   
   
 static void  
 fdesc(struct curparse *curp)  
 {  
         struct buf       ln, blk;  
         int              i, pos, lnn, lnn_start, with_mmap;  
         enum rofferr     re;  
         struct man      *man;  
         struct mdoc     *mdoc;  
         struct roff     *roff;  
   
         man = NULL;  
         mdoc = NULL;  
         roff = NULL;  
         memset(&ln, 0, sizeof(struct buf));  
   
         /*          /*
          * Two buffers: ln and buf.  buf is the input file and may be           * With -Wstop and warnings or errors of at least the requested
          * memory mapped.  ln is a line buffer and grows on-demand.           * level, do not produce output.
          */           */
   
         if ( ! read_whole_file(curp, &blk, &with_mmap))          if (MANDOCLEVEL_OK != rc && curp->wstop)
                 return;                  goto cleanup;
   
         if (NULL == curp->roff)  
                 curp->roff = roff_init(curp);  
         if (NULL == (roff = curp->roff))  
                 goto bailout;  
   
         for (i = 0, lnn = 1; i < (int)blk.sz;) {  
                 pos = 0;  
                 lnn_start = lnn;  
                 while (i < (int)blk.sz) {  
                         if ('\n' == blk.buf[i]) {  
                                 ++i;  
                                 ++lnn;  
                                 break;  
                         }  
                         /* Trailing backslash is like a plain character. */  
                         if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {  
                                 if (pos >= (int)ln.sz)  
                                         if (! resize_buf(&ln, 256))  
                                                 goto bailout;  
                                 ln.buf[pos++] = blk.buf[i++];  
                                 continue;  
                         }  
                         /* Found an escape and at least one other character. */  
                         if ('\n' == blk.buf[i + 1]) {  
                                 /* Escaped newlines are skipped over */  
                                 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 and continue. */  
                         if (pos + 1 >= (int)ln.sz)  
                                 if (! resize_buf(&ln, 256))  
                                         goto bailout;  
   
                         ln.buf[pos++] = blk.buf[i++];  
                         ln.buf[pos++] = blk.buf[i++];  
                 }  
   
                 if (pos >= (int)ln.sz)  
                         if (! resize_buf(&ln, 256))  
                                 goto bailout;  
                 ln.buf[pos] = '\0';  
   
                 re = roff_parseln(roff, lnn_start, &ln.buf, &ln.sz);  
                 if (ROFF_IGN == re)  
                         continue;  
                 else if (ROFF_ERR == re)  
                         goto bailout;  
   
                 /* If unset, assign parser in pset(). */  
   
                 if ( ! (man || mdoc) && ! pset(ln.buf, pos, curp, &man, &mdoc))  
                         goto bailout;  
   
                 /* Pass down into parsers. */  
   
                 if (man && ! man_parseln(man, lnn_start, ln.buf))  
                         goto bailout;  
                 if (mdoc && ! mdoc_parseln(mdoc, lnn_start, ln.buf))  
                         goto bailout;  
         }  
   
         /* NOTE a parser may not have been assigned, yet. */  
   
         if ( ! (man || mdoc)) {  
                 fprintf(stderr, "%s: Not a manual\n", curp->file);  
                 goto bailout;  
         }  
   
         if (mdoc && ! mdoc_endparse(mdoc))  
                 goto bailout;  
         if (man && ! man_endparse(man))  
                 goto bailout;  
         if (roff && ! roff_endparse(roff))  
                 goto bailout;  
   
         /* If unset, allocate output dev now (if applicable). */          /* 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):                  case OUTT_XHTML:
                         curp->outdata = xhtml_alloc(curp->outopts);                          curp->outdata = xhtml_alloc(curp->outopts);
                         curp->outman = html_man;  
                         curp->outmdoc = html_mdoc;  
                         curp->outfree = html_free;                          curp->outfree = html_free;
                         break;                          break;
                 case (OUTT_HTML):                  case OUTT_HTML:
                         curp->outdata = html_alloc(curp->outopts);                          curp->outdata = html_alloc(curp->outopts);
                           curp->outfree = html_free;
                           break;
                   case OUTT_UTF8:
                           curp->outdata = utf8_alloc(curp->outopts);
                           curp->outfree = ascii_free;
                           break;
                   case OUTT_LOCALE:
                           curp->outdata = locale_alloc(curp->outopts);
                           curp->outfree = ascii_free;
                           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->outman = html_man;
                         curp->outmdoc = html_mdoc;                          curp->outmdoc = html_mdoc;
                         curp->outfree = html_free;  
                         break;                          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_MAN:
                           curp->outmdoc = man_mdoc;
                           curp->outman = man_man;
                         break;                          break;
                 default:                  case OUTT_PDF:
                         curp->outdata = ascii_alloc(80);                          /* FALLTHROUGH */
                   case OUTT_ASCII:
                           /* FALLTHROUGH */
                   case OUTT_UTF8:
                           /* FALLTHROUGH */
                   case OUTT_LOCALE:
                           /* 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;
                 }                  }
         }          }
   
           mparse_result(curp->mp, &mdoc, &man, NULL);
   
         /* Execute the out device, if it exists. */          /* Execute the out device, if it exists. */
   
         if (man && curp->outman)          if (man && curp->outman)
Line 539  fdesc(struct curparse *curp)
Line 541  fdesc(struct curparse *curp)
                 (*curp->outmdoc)(curp->outdata, mdoc);                  (*curp->outmdoc)(curp->outdata, mdoc);
   
  cleanup:   cleanup:
         if (mdoc)  
                 mdoc_reset(mdoc);  
         if (man)  
                 man_reset(man);  
         if (roff)  
                 roff_reset(roff);  
         if (ln.buf)  
                 free(ln.buf);  
         if (with_mmap)  
                 munmap(blk.buf, blk.sz);  
         else  
                 free(blk.buf);  
   
         return;          mparse_reset(curp->mp);
   
  bailout:          if (*level < rc)
         with_error = 1;                  *level = rc;
         goto cleanup;  
 }  }
   
   static enum mandoclevel
 static int  passthrough(const char *file)
 pset(const char *buf, int pos, struct curparse *curp,  
                 struct man **man, struct mdoc **mdoc)  
 {  {
         int              i;          char             buf[BUFSIZ];
           const char      *syscall;
           ssize_t          nr, nw, off;
           int              fd;
   
         /*          fd = open(file, O_RDONLY);
          * Try to intuit which kind of manual parser should be used.  If          if (fd == -1) {
          * passed in by command-line (-man, -mdoc), then use that                  syscall = "open";
          * explicitly.  If passed as -mandoc, then try to guess from the                  goto fail;
          * line: either skip dot-lines, use -mdoc when finding `.Dt', or  
          * default to -man, which is more lenient.  
          */  
   
         if (buf[0] == '.') {  
                 for (i = 1; buf[i]; i++)  
                         if (' ' != buf[i] && '\t' != buf[i])  
                                 break;  
                 if (0 == buf[i])  
                         return(1);  
         }          }
   
         switch (curp->inttype) {          while ((nr = read(fd, buf, BUFSIZ)) != -1 && nr != 0)
         case (INTT_MDOC):                  for (off = 0; off < nr; off += nw)
                 if (NULL == curp->mdoc)                          if ((nw = write(STDOUT_FILENO, buf + off,
                         curp->mdoc = mdoc_init(curp);                              (size_t)(nr - off))) == -1 || nw == 0) {
                 if (NULL == (*mdoc = curp->mdoc))                                  syscall = "write";
                         return(0);                                  goto fail;
                 return(1);                          }
         case (INTT_MAN):  
                 if (NULL == curp->man)  
                         curp->man = man_init(curp);  
                 if (NULL == (*man = curp->man))  
                         return(0);  
                 return(1);  
         default:  
                 break;  
         }  
   
         if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3))  {          if (nr == 0) {
                 if (NULL == curp->mdoc)                  close(fd);
                         curp->mdoc = mdoc_init(curp);                  return(MANDOCLEVEL_OK);
                 if (NULL == (*mdoc = curp->mdoc))          }
                         return(0);  
                 return(1);  
         }  
   
         if (NULL == curp->man)          syscall = "read";
                 curp->man = man_init(curp);  fail:
         if (NULL == (*man = curp->man))          fprintf(stderr, "%s: %s: SYSERR: %s: %s",
                 return(0);              progname, file, syscall, strerror(errno));
         return(1);          return(MANDOCLEVEL_SYSERR);
 }  }
   
   
 static int  static int
 moptions(enum intt *tflags, char *arg)  moptions(int *options, char *arg)
 {  {
   
         if (0 == strcmp(arg, "doc"))          if (arg == NULL)
                 *tflags = INTT_MDOC;                  /* nothing to do */;
           else if (0 == strcmp(arg, "doc"))
                   *options |= MPARSE_MDOC;
         else if (0 == strcmp(arg, "andoc"))          else if (0 == strcmp(arg, "andoc"))
                 *tflags = INTT_AUTO;                  /* nothing to do */;
         else if (0 == strcmp(arg, "an"))          else if (0 == strcmp(arg, "an"))
                 *tflags = INTT_MAN;                  *options |= MPARSE_MAN;
         else {          else {
                 fprintf(stderr, "%s: Bad argument\n", arg);                  fprintf(stderr, "%s: -m%s: Bad argument\n",
                       progname, arg);
                 return(0);                  return(0);
         }          }
   
         return(1);          return(1);
 }  }
   
   
 static int  static int
 toptions(struct curparse *curp, char *arg)  toptions(struct curparse *curp, char *arg)
 {  {
Line 642  toptions(struct curparse *curp, char *arg)
Line 611  toptions(struct curparse *curp, char *arg)
                 curp->outtype = OUTT_ASCII;                  curp->outtype = OUTT_ASCII;
         else if (0 == strcmp(arg, "lint")) {          else if (0 == strcmp(arg, "lint")) {
                 curp->outtype = OUTT_LINT;                  curp->outtype = OUTT_LINT;
                 curp->wflags |= WARN_WALL;                  curp->wlevel  = MANDOCLEVEL_WARNING;
                 curp->fflags |= FL_STRICT;          } else if (0 == strcmp(arg, "tree"))
         }  
         else if (0 == strcmp(arg, "tree"))  
                 curp->outtype = OUTT_TREE;                  curp->outtype = OUTT_TREE;
           else if (0 == strcmp(arg, "man"))
                   curp->outtype = OUTT_MAN;
         else if (0 == strcmp(arg, "html"))          else if (0 == strcmp(arg, "html"))
                 curp->outtype = OUTT_HTML;                  curp->outtype = OUTT_HTML;
           else if (0 == strcmp(arg, "utf8"))
                   curp->outtype = OUTT_UTF8;
           else if (0 == strcmp(arg, "locale"))
                   curp->outtype = OUTT_LOCALE;
         else if (0 == strcmp(arg, "xhtml"))          else if (0 == strcmp(arg, "xhtml"))
                 curp->outtype = OUTT_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 {
                 fprintf(stderr, "%s: Bad argument\n", arg);                  fprintf(stderr, "%s: -T%s: Bad argument\n",
                       progname, arg);
                 return(0);                  return(0);
         }          }
   
         return(1);          return(1);
 }  }
   
   
 static int  static int
 foptions(int *fflags, char *arg)  woptions(struct curparse *curp, char *arg)
 {  {
         char            *v, *o;          char            *v, *o;
         const char      *toks[8];          const char      *toks[6];
   
         toks[0] = "ign-scope";          toks[0] = "stop";
         toks[1] = "no-ign-escape";          toks[1] = "all";
         toks[2] = "no-ign-macro";          toks[2] = "warning";
         toks[3] = "ign-errors";          toks[3] = "error";
         toks[4] = "strict";          toks[4] = "fatal";
         toks[5] = "ign-escape";          toks[5] = NULL;
         toks[6] = NULL;  
   
         while (*arg) {          while (*arg) {
                 o = arg;                  o = arg;
                 switch (getsubopt(&arg, UNCONST(toks), &v)) {                  switch (getsubopt(&arg, UNCONST(toks), &v)) {
                 case (0):                  case 0:
                         *fflags |= FL_IGN_SCOPE;                          curp->wstop = 1;
                         break;                          break;
                 case (1):                  case 1:
                         *fflags |= FL_NIGN_ESCAPE;                          /* FALLTHROUGH */
                   case 2:
                           curp->wlevel = MANDOCLEVEL_WARNING;
                         break;                          break;
                 case (2):                  case 3:
                         *fflags |= FL_NIGN_MACRO;                          curp->wlevel = MANDOCLEVEL_ERROR;
                         break;                          break;
                 case (3):                  case 4:
                         *fflags |= FL_IGN_ERRORS;                          curp->wlevel = MANDOCLEVEL_FATAL;
                         break;                          break;
                 case (4):  
                         *fflags |= FL_STRICT;  
                         break;  
                 case (5):  
                         *fflags &= ~FL_NIGN_ESCAPE;  
                         break;  
                 default:                  default:
                         fprintf(stderr, "%s: Bad argument\n", o);                          fprintf(stderr, "%s: -W%s: Bad argument\n",
                               progname, o);
                         return(0);                          return(0);
                 }                  }
         }          }
Line 704  foptions(int *fflags, char *arg)
Line 677  foptions(int *fflags, char *arg)
         return(1);          return(1);
 }  }
   
   static void
 static int  mmsg(enum mandocerr t, enum mandoclevel lvl,
 woptions(int *wflags, char *arg)                  const char *file, int line, int col, const char *msg)
 {  {
         char            *v, *o;          const char      *mparse_msg;
         const char      *toks[3];  
   
         toks[0] = "all";          fprintf(stderr, "%s: %s:", progname, file);
         toks[1] = "error";  
         toks[2] = NULL;  
   
         while (*arg) {          if (line)
                 o = arg;                  fprintf(stderr, "%d:%d:", line, col + 1);
                 switch (getsubopt(&arg, UNCONST(toks), &v)) {  
                 case (0):  
                         *wflags |= WARN_WALL;  
                         break;  
                 case (1):  
                         *wflags |= WARN_WERR;  
                         break;  
                 default:  
                         fprintf(stderr, "%s: Bad argument\n", o);  
                         return(0);  
                 }  
         }  
   
         return(1);          fprintf(stderr, " %s", mparse_strlevel(lvl));
 }  
   
           if (NULL != (mparse_msg = mparse_strerror(t)))
                   fprintf(stderr, ": %s", mparse_msg);
   
 /* ARGSUSED */          if (msg)
 static int                  fprintf(stderr, ": %s", msg);
 merr(void *arg, int line, int col, const char *msg)  
 {  
         struct curparse *curp;  
   
         curp = (struct curparse *)arg;          fputc('\n', stderr);
   
         (void)fprintf(stderr, "%s:%d:%d: error: %s\n",  
                         curp->file, line, col + 1, msg);  
   
         with_error = 1;  
   
         return(0);  
 }  }
   
   static void
 static int  spawn_pager(void)
 mwarn(void *arg, int line, int col, const char *msg)  
 {  {
         struct curparse *curp;  #define MAX_PAGER_ARGS 16
           char            *argv[MAX_PAGER_ARGS];
           const char      *pager;
           char            *cp;
           int              fildes[2];
           int              argc;
   
         curp = (struct curparse *)arg;          if (pipe(fildes) == -1) {
                   fprintf(stderr, "%s: pipe: %s\n",
                       progname, strerror(errno));
                   return;
           }
   
         if ( ! (curp->wflags & WARN_WALL))          switch (fork()) {
                 return(1);          case -1:
                   fprintf(stderr, "%s: fork: %s\n",
                       progname, strerror(errno));
                   exit((int)MANDOCLEVEL_SYSERR);
           case 0:
                   close(fildes[0]);
                   if (dup2(fildes[1], STDOUT_FILENO) == -1) {
                           fprintf(stderr, "%s: dup output: %s\n",
                               progname, strerror(errno));
                           exit((int)MANDOCLEVEL_SYSERR);
                   }
                   return;
           default:
                   break;
           }
   
         (void)fprintf(stderr, "%s:%d:%d: warning: %s\n",          /* The original process becomes the pager. */
                         curp->file, line, col + 1, msg);  
   
         with_warning = 1;          close(fildes[1]);
         if (curp->wflags & WARN_WERR) {          if (dup2(fildes[0], STDIN_FILENO) == -1) {
                 with_error = 1;                  fprintf(stderr, "%s: dup input: %s\n",
                 return(0);                      progname, strerror(errno));
                   exit((int)MANDOCLEVEL_SYSERR);
         }          }
   
         return(1);          pager = getenv("MANPAGER");
 }          if (pager == NULL || *pager == '\0')
                   pager = getenv("PAGER");
           if (pager == NULL || *pager == '\0')
                   pager = "/usr/bin/more -s";
           cp = mandoc_strdup(pager);
   
 /*          /*
  * XXX: this is experimental code that will eventually become the           * Parse the pager command into words.
  * generic means of covering all warnings and errors!           * Intentionally do not do anything fancy here.
  */           */
 /* ARGSUSED */  
 static int  
 mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg)  
 {  
         struct curparse *cp;  
   
         cp = (struct curparse *)arg;          argc = 0;
           while (argc + 1 < MAX_PAGER_ARGS) {
                   argv[argc++] = cp;
                   cp = strchr(cp, ' ');
                   if (cp == NULL)
                           break;
                   *cp++ = '\0';
                   while (*cp == ' ')
                           cp++;
                   if (*cp == '\0')
                           break;
           }
           argv[argc] = NULL;
   
         fprintf(stderr, "%s:%d:%d: %s\n", cp->file, ln, col + 1, msg);          /* Hand over to the pager. */
   
         return(1);          execvp(argv[0], argv);
           fprintf(stderr, "%s: exec: %s\n",
               progname, strerror(errno));
           exit((int)MANDOCLEVEL_SYSERR);
 }  }
Legend:
Removed from v.1.71  
changed lines
  Added in v.1.188
CVSweb