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

Diff for /mandoc/main.c between version 1.110 and 1.189

version 1.110, 2010/12/01 10:31:34 version 1.189, 2014/09/01 22:45:53
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>   * 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 15 
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 <ctype.h>
   #include <errno.h>
 #include <fcntl.h>  #include <fcntl.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdint.h>  #include <stdint.h>
Line 32 
Line 31 
 #include <unistd.h>  #include <unistd.h>
   
 #include "mandoc.h"  #include "mandoc.h"
   #include "mandoc_aux.h"
 #include "main.h"  #include "main.h"
 #include "mdoc.h"  #include "mdoc.h"
 #include "man.h"  #include "man.h"
 #include "roff.h"  #include "manpath.h"
   #include "mansearch.h"
   
 #ifndef MAP_FILE  
 #define MAP_FILE        0  
 #endif  
   
 #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_PS,          OUTT_HTML,      /* -Thtml */
         OUTT_PDF          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 */
         enum mandoclevel  wlevel;       /* Ignore messages below this. */          int               wstop;        /* stop after a file with a warning */
         int               wstop;        /* Stop after a file with a warning. */          enum outt         outtype;      /* which output to use */
         enum intt         inttype;      /* which parser to use */  
         struct man       *man;          /* man parser */  
         struct mdoc      *mdoc;         /* mdoc parser */  
         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_mdoc          outmdoc;      /* mdoc output ptr */
         out_man           outman;       /* man output ptr */          out_man           outman;       /* man output ptr */
         out_free          outfree;      /* free output ptr */          out_free          outfree;      /* free output ptr */
         void             *outdata;      /* data for output */          void             *outdata;      /* data for output */
         char              outopts[BUFSIZ]; /* buf of output opts */          char              outopts[BUFSIZ]; /* buf of output opts */
 };  };
   
 static  const char * const      mandoclevels[MANDOCLEVEL_MAX] = {  static  int               moptions(int *, char *);
         "SUCCESS",  static  void              mmsg(enum mandocerr, enum mandoclevel,
         "RESERVED",                                  const char *, int, int, const char *);
         "WARNING",  static  void              parse(struct curparse *, int,
         "ERROR",                                  const char *, enum mandoclevel *);
         "FATAL",  static  enum mandoclevel  passthrough(const char *);
         "BADARG",  static  void              spawn_pager(void);
         "SYSERR"  
 };  
   
 static  const enum mandocerr    mandoclimits[MANDOCLEVEL_MAX] = {  
         MANDOCERR_OK,  
         MANDOCERR_WARNING,  
         MANDOCERR_WARNING,  
         MANDOCERR_ERROR,  
         MANDOCERR_FATAL,  
         MANDOCERR_MAX,  
         MANDOCERR_MAX  
 };  
   
 static  const char * const      mandocerrs[MANDOCERR_MAX] = {  
         "ok",  
   
         "generic warning",  
   
         "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",  
         "no document body",  
         "no document prologue",  
         "utsname system call failed",  
         "static buffer exhausted",  
 };  
   
 static  void              fdesc(struct curparse *);  
 static  void              ffile(const char *, struct curparse *);  
 static  int               moptions(enum intt *, char *);  
 static  int               mmsg(enum mandocerr, void *,  
                                 int, int, const char *);  
 static  void              pset(const char *, int, struct curparse *,  
                                 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(struct curparse *, 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  enum mandoclevel  exit_status = MANDOCLEVEL_OK;  
   
   
 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 220  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;          curp.wlevel  = MANDOCLEVEL_FATAL;
           options = MPARSE_SO;
           defos = NULL;
   
         /* LINTED */          use_pager = 1;
         while (-1 != (c = getopt(argc, argv, "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 ('m'):                  case 'a':
                         if ( ! moptions(&curp.inttype, optarg))                          outmode = OUTMODE_ALL;
                           break;
                   case 'C':
                           conf_file = optarg;
                           break;
                   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);                                  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;                          break;
                 case ('O'):                  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((int)MANDOCLEVEL_BADARG);                                  return((int)MANDOCLEVEL_BADARG);
                         break;                          break;
                 case ('W'):                  case 'W':
                         if ( ! woptions(&curp, optarg))                          if ( ! woptions(&curp, optarg))
                                 return((int)MANDOCLEVEL_BADARG);                                  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:
         while (*argv) {                          outmode = OUTMODE_ALL;
                 ffile(*argv, &curp);                          use_pager = 0;
                 if (MANDOCLEVEL_OK != exit_status && curp.wstop)  
                         break;                          break;
                 ++argv;                  case ARG_NAME:
                           outmode = OUTMODE_ONE;
                           break;
                   default:
                           outmode = OUTMODE_LST;
                           break;
                   }
         }          }
   
         if (curp.outfree)          /* Parse arguments. */
                 (*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((int)exit_status);          argc -= optind;
 }          argv += optind;
   #if HAVE_SQLITE3
           resp = NULL;
   #endif
   
           /* Quirk for a man(1) section argument without -s. */
   
 static void          if (search.argmode == ARG_NAME &&
 version(void)              argv[0] != NULL &&
 {              isdigit((unsigned char)argv[0][0]) &&
               (argv[0][1] == '\0' || !strcmp(argv[0], "3p"))) {
                   search.sec = argv[0];
                   argv++;
                   argc--;
           }
   
         (void)printf("%s %s\n", progname, VERSION);          rc = MANDOCLEVEL_OK;
         exit((int)MANDOCLEVEL_OK);  
 }  
   
           /* man(1), whatis(1), apropos(1) */
   
 static void          if (search.argmode != ARG_FILE) {
 usage(void)  #if HAVE_SQLITE3
 {                  if (argc == 0)
                           usage(search.argmode);
   
         (void)fprintf(stderr, "usage: %s [-V] [-foption] "                  /* Access the mandoc database. */
                         "[-mformat] [-Ooption] [-Toutput] "  
                         "[-Werr] [file...]\n", progname);  
         exit((int)MANDOCLEVEL_BADARG);  
 }  
   
                   manpath_parse(&paths, conf_file, defpaths, auxpaths);
                   mansearch_setup(1);
                   if( ! mansearch(&search, &paths, argc, argv, &res, &sz))
                           usage(search.argmode);
                   resp = res;
   
 static void                  if (sz == 0) {
 ffile(const char *file, struct curparse *curp)                          if (search.argmode == ARG_NAME)
 {                                  fprintf(stderr, "%s: No entry for %s "
                                       "in the manual.\n", progname, argv[0]);
                           rc = MANDOCLEVEL_BADARG;
                           goto out;
                   }
   
         curp->file = file;                  /*
         if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {                   * For standard man(1) and -a output mode,
                 perror(curp->file);                   * prepare for copying filename pointers
                 exit_status = MANDOCLEVEL_SYSERR;                   * into the program parameter array.
                 return;                   */
         }  
   
         fdesc(curp);                  if (outmode == OUTMODE_ONE) {
                           argc = 1;
                           best_prio = 10;
                   } else if (outmode == OUTMODE_ALL)
                           argc = (int)sz;
   
         if (-1 == close(curp->fd))                  /* Iterate all matching manuals. */
                 perror(curp->file);  
 }  
   
                   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;
                           }
                   }
   
 static void                  /*
 resize_buf(struct buf *buf, size_t initial)                   * 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.
                    */
   
         buf->sz = buf->sz ? 2 * buf->sz : initial;                  if (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
         buf->buf = realloc(buf->buf, buf->sz);                          goto out;
         if (NULL == buf->buf) {  #else
                 perror(NULL);                  fputs("mandoc: database support not compiled in\n",
                 exit((int)MANDOCLEVEL_SYSERR);                      stderr);
                   return((int)MANDOCLEVEL_BADARG);
   #endif
         }          }
 }  
   
           /* mandoc(1) */
   
 static int          if ( ! moptions(&options, auxpaths))
 read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap)                  return((int)MANDOCLEVEL_BADARG);
 {  
         struct stat      st;  
         size_t           off;  
         ssize_t          ssz;  
   
         if (-1 == fstat(curp->fd, &st)) {          if (use_pager && isatty(STDOUT_FILENO))
                 perror(curp->file);                  spawn_pager();
                 return(0);  
         }  
   
           curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);
   
         /*          /*
          * If we're a regular file, try just reading in the whole entry           * Conditionally start up the lookaside buffer before parsing.
          * 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 (OUTT_MAN == curp.outtype)
                   mparse_keep(curp.mp);
   
         if (S_ISREG(st.st_mode)) {          if (argc == 0)
                 if (st.st_size >= (1U << 31)) {                  parse(&curp, STDIN_FILENO, "<stdin>", &rc);
                         fprintf(stderr, "%s: input too large\n",  
                                         curp->file);          while (argc) {
                         return(0);  #if HAVE_SQLITE3
                 }                  if (resp != NULL) {
                 *with_mmap = 1;                          if (resp->form) {
                 fb->sz = (size_t)st.st_size;                                  /* For .so only; ignore failure. */
                 fb->buf = mmap(NULL, fb->sz, PROT_READ,                                  chdir(paths.paths[resp->ipath]);
                                 MAP_FILE|MAP_SHARED, curp->fd, 0);                                  parse(&curp, -1, resp->file, &rc);
                 if (fb->buf != MAP_FAILED)                          } else
                         return(1);                                  rc = passthrough(resp->file);
                           resp++;
                   } else
   #endif
                           parse(&curp, -1, *argv++, &rc);
                   if (MANDOCLEVEL_OK != rc && curp.wstop)
                           break;
                   argc--;
         }          }
   
         /*          if (curp.outfree)
          * If this isn't a regular file (like, say, stdin), then we must                  (*curp.outfree)(curp.outdata);
          * go the old way and just read things in bit by bit.          if (curp.mp)
          */                  mparse_free(curp.mp);
   
         *with_mmap = 0;  #if HAVE_SQLITE3
         off = 0;  out:
         fb->sz = 0;          if (search.argmode != ARG_FILE) {
         fb->buf = NULL;                  manpath_free(&paths);
         for (;;) {                  mansearch_free(res, sz);
                 if (off == fb->sz) {                  mansearch_setup(0);
                         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;  
         }          }
   #endif
   
         free(fb->buf);          free(defos);
         fb->buf = NULL;  
         return(0);          return((int)rc);
 }  }
   
   
 static void  static void
 fdesc(struct curparse *curp)  version(void)
 {  {
         struct buf       ln, blk;  
         int              i, pos, lnn, lnn_start, with_mmap, of;  
         enum rofferr     re;  
         unsigned char    c;  
         struct man      *man;  
         struct mdoc     *mdoc;  
         struct roff     *roff;  
   
         man = NULL;          printf("mandoc %s\n", VERSION);
         mdoc = NULL;          exit((int)MANDOCLEVEL_OK);
         roff = NULL;  }
   
         memset(&ln, 0, sizeof(struct buf));  static void
   usage(enum argmode argmode)
   {
   
         /*          switch (argmode) {
          * Two buffers: ln and buf.  buf is the input file and may be          case ARG_FILE:
          * memory mapped.  ln is a line buffer and grows on-demand.                  fputs("usage: mandoc [-acfklV] [-Ios=name] "
          */                      "[-mformat] [-Ooption] [-Toutput] [-Wlevel]\n"
                       "\t      [file ...]\n", stderr);
         if ( ! read_whole_file(curp, &blk, &with_mmap)) {                  break;
                 exit_status = MANDOCLEVEL_SYSERR;          case ARG_NAME:
                 return;                  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;
         }          }
           exit((int)MANDOCLEVEL_BADARG);
   }
   
         if (NULL == curp->roff)  static void
                 curp->roff = roff_alloc(&curp->regs, curp, mmsg);  parse(struct curparse *curp, int fd, const char *file,
         assert(curp->roff);          enum mandoclevel *level)
         roff = curp->roff;  {
           enum mandoclevel  rc;
           struct mdoc      *mdoc;
           struct man       *man;
   
         for (i = 0, lnn = 1; i < (int)blk.sz;) {          /* Begin by parsing the file itself. */
                 pos = 0;  
                 lnn_start = lnn;  
                 while (i < (int)blk.sz) {  
                         if ('\n' == blk.buf[i]) {  
                                 ++i;  
                                 ++lnn;  
                                 break;  
                         }  
   
                         /*          assert(file);
                          * Warn about bogus characters.  If you're using          assert(fd >= -1);
                          * 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];          rc = mparse_readfd(curp->mp, fd, file);
                         if ( ! (isascii(c) && (isgraph(c) || isblank(c)))) {  
                                 mmsg(MANDOCERR_BADCHAR, curp,  
                                     lnn_start, pos, "ignoring byte");  
                                 i++;  
                                 continue;  
                         }  
   
                         /* Trailing backslash is like a plain character. */          /* Stop immediately if the parse has failed. */
                         if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {  
                                 if (pos >= (int)ln.sz)  
                                         resize_buf(&ln, 256);  
                                 ln.buf[pos++] = blk.buf[i++];  
                                 continue;  
                         }  
                         /* Found 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)  
                                 resize_buf(&ln, 256);  
   
                         ln.buf[pos++] = blk.buf[i++];          if (MANDOCLEVEL_FATAL <= rc)
                         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;  
                 do {  
                         re = roff_parseln(roff, lnn_start,  
                                         &ln.buf, &ln.sz, of, &of);  
                 } while (ROFF_RERUN == re);  
   
                 if (ROFF_IGN == re) {  
                         continue;  
                 } else if (ROFF_ERR == re) {  
                         assert(MANDOCLEVEL_FATAL <= exit_status);  
                         goto cleanup;  
                 }  
   
                 /*  
                  * If input parsers have not been allocated, do so now.  
                  * We keep these instanced betwen parsers, but set them  
                  * locally per parse routine since we can use different  
                  * parsers with each one.  
                  */  
   
                 if ( ! (man || mdoc))  
                         pset(ln.buf + of, pos - of, curp, &man, &mdoc);  
   
                 /* Lastly, push down into the parsers themselves. */  
   
                 if (man && ! man_parseln(man, lnn_start, ln.buf, of)) {  
                         assert(MANDOCLEVEL_FATAL <= exit_status);  
                         goto cleanup;  
                 }  
                 if (mdoc && ! mdoc_parseln(mdoc, lnn_start, ln.buf, of)) {  
                         assert(MANDOCLEVEL_FATAL <= exit_status);  
                         goto cleanup;  
                 }  
         }  
   
         /* NOTE a parser may not have been assigned, yet. */  
   
         if ( ! (man || mdoc)) {  
                 fprintf(stderr, "%s: Not a manual\n", curp->file);  
                 exit_status = MANDOCLEVEL_FATAL;  
                 goto cleanup;                  goto cleanup;
         }  
   
         /* Clean up the parse routine ASTs. */  
   
         if (mdoc && ! mdoc_endparse(mdoc)) {  
                 assert(MANDOCLEVEL_FATAL <= exit_status);  
                 goto cleanup;  
         }  
         if (man && ! man_endparse(man)) {  
                 assert(MANDOCLEVEL_FATAL <= exit_status);  
                 goto cleanup;  
         }  
         if (roff && ! roff_endparse(roff)) {  
                 assert(MANDOCLEVEL_FATAL <= exit_status);  
                 goto cleanup;  
         }  
   
         /*          /*
          * With -Wstop and warnings or errors of at least           * With -Wstop and warnings or errors of at least the requested
          * the requested level, do not produce output.           * level, do not produce output.
          */           */
   
         if (MANDOCLEVEL_OK != exit_status && curp->wstop)          if (MANDOCLEVEL_OK != rc && curp->wstop)
                 goto cleanup;                  goto cleanup;
   
         /* 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->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;                          break;
                 case (OUTT_ASCII):                  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->outdata = ascii_alloc(curp->outopts);
                         curp->outfree = ascii_free;                          curp->outfree = ascii_free;
                         break;                          break;
                 case (OUTT_PDF):                  case OUTT_PDF:
                         curp->outdata = pdf_alloc(curp->outopts);                          curp->outdata = pdf_alloc(curp->outopts);
                         curp->outfree = pspdf_free;                          curp->outfree = pspdf_free;
                         break;                          break;
                 case (OUTT_PS):                  case OUTT_PS:
                         curp->outdata = ps_alloc(curp->outopts);                          curp->outdata = ps_alloc(curp->outopts);
                         curp->outfree = pspdf_free;                          curp->outfree = pspdf_free;
                         break;                          break;
Line 609  fdesc(struct curparse *curp)
Line 502  fdesc(struct curparse *curp)
                 }                  }
   
                 switch (curp->outtype) {                  switch (curp->outtype) {
                 case (OUTT_HTML):                  case OUTT_HTML:
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (OUTT_XHTML):                  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_PDF):                  case OUTT_MAN:
                           curp->outmdoc = man_mdoc;
                           curp->outman = man_man;
                           break;
                   case OUTT_PDF:
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (OUTT_ASCII):                  case OUTT_ASCII:
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (OUTT_PS):                  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;
                         break;                          break;
Line 633  fdesc(struct curparse *curp)
Line 533  fdesc(struct curparse *curp)
                 }                  }
         }          }
   
           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 641  fdesc(struct curparse *curp)
Line 543  fdesc(struct curparse *curp)
                 (*curp->outmdoc)(curp->outdata, mdoc);                  (*curp->outmdoc)(curp->outdata, mdoc);
   
  cleanup:   cleanup:
         memset(&curp->regs, 0, sizeof(struct regset));  
         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);
   
           if (*level < rc)
                   *level = rc;
 }  }
   
   static enum mandoclevel
 static void  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] || '\'' == buf[0]) {  
                 for (i = 1; buf[i]; i++)  
                         if (' ' != buf[i] && '\t' != buf[i])  
                                 break;  
                 if ('\0' == buf[i])  
                         return;  
         }          }
   
         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_alloc(&curp->regs, curp, mmsg);                              (size_t)(nr - off))) == -1 || nw == 0) {
                 assert(curp->mdoc);                                  syscall = "write";
                 *mdoc = curp->mdoc;                                  goto fail;
                 return;                          }
         case (INTT_MAN):  
                 if (NULL == curp->man)  
                         curp->man = man_alloc(&curp->regs, curp, mmsg);  
                 assert(curp->man);  
                 *man = curp->man;  
                 return;  
         default:  
                 break;  
         }  
   
         if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3))  {          if (nr == 0) {
                 if (NULL == curp->mdoc)                  close(fd);
                         curp->mdoc = mdoc_alloc(&curp->regs, curp, mmsg);                  return(MANDOCLEVEL_OK);
                 assert(curp->mdoc);          }
                 *mdoc = curp->mdoc;  
                 return;  
         }  
   
         if (NULL == curp->man)          syscall = "read";
                 curp->man = man_alloc(&curp->regs, curp, mmsg);  fail:
         assert(curp->man);          fprintf(stderr, "%s: %s: SYSERR: %s: %s",
         *man = curp->man;              progname, file, syscall, strerror(errno));
           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 741  toptions(struct curparse *curp, char *arg)
Line 614  toptions(struct curparse *curp, char *arg)
         else if (0 == strcmp(arg, "lint")) {          else if (0 == strcmp(arg, "lint")) {
                 curp->outtype = OUTT_LINT;                  curp->outtype = OUTT_LINT;
                 curp->wlevel  = MANDOCLEVEL_WARNING;                  curp->wlevel  = MANDOCLEVEL_WARNING;
         }          } 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"))          else if (0 == strcmp(arg, "ps"))
Line 753  toptions(struct curparse *curp, char *arg)
Line 631  toptions(struct curparse *curp, char *arg)
         else if (0 == strcmp(arg, "pdf"))          else if (0 == strcmp(arg, "pdf"))
                 curp->outtype = OUTT_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
 woptions(struct curparse *curp, char *arg)  woptions(struct curparse *curp, char *arg)
 {  {
         char            *v, *o;          char            *v, *o;
         const char      *toks[6];          const char      *toks[6];
   
         toks[0] = "stop";          toks[0] = "stop";
         toks[1] = "all";          toks[1] = "all";
Line 777  woptions(struct curparse *curp, char *arg)
Line 655  woptions(struct curparse *curp, char *arg)
         while (*arg) {          while (*arg) {
                 o = arg;                  o = arg;
                 switch (getsubopt(&arg, UNCONST(toks), &v)) {                  switch (getsubopt(&arg, UNCONST(toks), &v)) {
                 case (0):                  case 0:
                         curp->wstop = 1;                          curp->wstop = 1;
                         break;                          break;
                 case (1):                  case 1:
                         /* FALLTHROUGH */                          /* FALLTHROUGH */
                 case (2):                  case 2:
                         curp->wlevel = MANDOCLEVEL_WARNING;                          curp->wlevel = MANDOCLEVEL_WARNING;
                         break;                          break;
                 case (3):                  case 3:
                         curp->wlevel = MANDOCLEVEL_ERROR;                          curp->wlevel = MANDOCLEVEL_ERROR;
                         break;                          break;
                 case (4):                  case 4:
                         curp->wlevel = MANDOCLEVEL_FATAL;                          curp->wlevel = MANDOCLEVEL_FATAL;
                         break;                          break;
                 default:                  default:
                         fprintf(stderr, "-W%s: Bad argument\n", o);                          fprintf(stderr, "%s: -W%s: Bad argument\n",
                               progname, o);
                         return(0);                          return(0);
                 }                  }
         }          }
Line 800  woptions(struct curparse *curp, char *arg)
Line 679  woptions(struct curparse *curp, char *arg)
         return(1);          return(1);
 }  }
   
   static void
 static int  mmsg(enum mandocerr t, enum mandoclevel lvl,
 mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg)                  const char *file, int line, int col, const char *msg)
 {  {
         struct curparse *cp;          const char      *mparse_msg;
         enum mandoclevel level;  
   
         level = MANDOCLEVEL_FATAL;          fprintf(stderr, "%s: %s:", progname, file);
         while (t < mandoclimits[level])  
                 /* LINTED */  
                 level--;  
   
         cp = (struct curparse *)arg;          if (line)
         if (level < cp->wlevel)                  fprintf(stderr, "%d:%d:", line, col + 1);
                 return(1);  
   
         fprintf(stderr, "%s:%d:%d: %s: %s",          fprintf(stderr, " %s", mparse_strlevel(lvl));
             cp->file, ln, col + 1, mandoclevels[level], mandocerrs[t]);  
           if (NULL != (mparse_msg = mparse_strerror(t)))
                   fprintf(stderr, ": %s", mparse_msg);
   
         if (msg)          if (msg)
                 fprintf(stderr, ": %s", msg);                  fprintf(stderr, ": %s", msg);
   
         fputc('\n', stderr);          fputc('\n', stderr);
   }
   
         if (exit_status < level)  static void
                 exit_status = level;  spawn_pager(void)
   {
         return(level < MANDOCLEVEL_FATAL);  #define MAX_PAGER_ARGS 16
           char            *argv[MAX_PAGER_ARGS];
           const char      *pager;
           char            *cp;
           int              fildes[2];
           int              argc;
   
           if (pipe(fildes) == -1) {
                   fprintf(stderr, "%s: pipe: %s\n",
                       progname, strerror(errno));
                   return;
           }
   
           switch (fork()) {
           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;
           }
   
           /* The original process becomes the pager. */
   
           close(fildes[1]);
           if (dup2(fildes[0], STDIN_FILENO) == -1) {
                   fprintf(stderr, "%s: dup input: %s\n",
                       progname, strerror(errno));
                   exit((int)MANDOCLEVEL_SYSERR);
           }
   
           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);
   
           /*
            * Parse the pager command into words.
            * Intentionally do not do anything fancy here.
            */
   
           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;
   
           /* Hand over to the pager. */
   
           execvp(argv[0], argv);
           fprintf(stderr, "%s: exec: %s\n",
               progname, strerror(errno));
           exit((int)MANDOCLEVEL_SYSERR);
 }  }
Legend:
Removed from v.1.110  
changed lines
  Added in v.1.189
CVSweb