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

Diff for /mandoc/main.c between version 1.34 and 1.202

version 1.34, 2009/07/04 11:10:36 version 1.202, 2014/12/05 21:55:04
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.
  */   */
 #include <sys/stat.h>  #include "config.h"
   
   #include <sys/types.h>
   
 #include <assert.h>  #include <assert.h>
 #include <err.h>  #include <ctype.h>
   #include <errno.h>
 #include <fcntl.h>  #include <fcntl.h>
 #include <stdio.h>  #include <stdio.h>
   #include <stdint.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
 #include <unistd.h>  #include <unistd.h>
   
   #include "mandoc.h"
   #include "mandoc_aux.h"
   #include "main.h"
 #include "mdoc.h"  #include "mdoc.h"
 #include "man.h"  #include "man.h"
   #include "manpath.h"
   #include "mansearch.h"
   
 /* Account for FreeBSD and Linux in our declarations. */  #if !defined(__GNUC__) || (__GNUC__ < 2)
   # if !defined(lint)
 #ifdef __linux__  #  define __attribute__(x)
 extern  int               getsubopt(char **, char * const *, char **);  
 # ifndef __dead  
 #  define __dead __attribute__((__noreturn__))  
 # endif  # endif
 #elif defined(__dead2)  #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
 # ifndef __dead  
 #  define __dead __dead2  
 # endif  
 #endif  
   
 typedef int             (*out_mdoc)(void *, const struct mdoc *);  enum    outmode {
 typedef int             (*out_man)(void *, const struct man *);          OUTMODE_DEF = 0,
 typedef void            (*out_free)(void *);          OUTMODE_FLN,
           OUTMODE_LST,
 struct  buf {          OUTMODE_ALL,
         char             *buf;          OUTMODE_INT,
         size_t            sz;          OUTMODE_ONE
 };  };
   
 enum    intt {  typedef void            (*out_mdoc)(void *, const struct mdoc *);
         INTT_AUTO,  typedef void            (*out_man)(void *, const struct man *);
         INTT_MDOC,  typedef void            (*out_free)(void *);
         INTT_MAN  
 };  
   
 enum    outt {  enum    outt {
         OUTT_ASCII = 0,          OUTT_ASCII = 0, /* -Tascii */
         OUTT_TREE,          OUTT_LOCALE,    /* -Tlocale */
         OUTT_LINT          OUTT_UTF8,      /* -Tutf8 */
           OUTT_TREE,      /* -Ttree */
           OUTT_MAN,       /* -Tman */
           OUTT_HTML,      /* -Thtml */
           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. */          struct mchars    *mchars;       /* character table */
         int               wflags;          enum mandoclevel  wlevel;       /* ignore messages below this */
 #define WARN_WALL         0x03          /* All-warnings mask. */          int               wstop;        /* stop after a file with a warning */
 #define WARN_WCOMPAT     (1 << 0)       /* Compatibility warnings. */          enum outt         outtype;      /* which output to use */
 #define WARN_WSYNTAX     (1 << 1)       /* Syntax warnings. */          out_mdoc          outmdoc;      /* mdoc output ptr */
 #define WARN_WERR        (1 << 2)       /* Warnings->errors. */          out_man           outman;       /* man output ptr */
         int               fflags;          out_free          outfree;      /* free output ptr */
 #define IGN_SCOPE        (1 << 0)       /* Ignore scope errors. */          void             *outdata;      /* data for output */
 #define NO_IGN_ESCAPE    (1 << 1)       /* Don't ignore bad escapes. */          char              outopts[BUFSIZ]; /* buf of output opts */
 #define NO_IGN_MACRO     (1 << 2)       /* Don't ignore bad macros. */  
 #define NO_IGN_CHARS     (1 << 3)       /* Don't ignore bad chars. */  
         enum intt         inttype;      /* Input parsers... */  
         struct man       *man;  
         struct man       *lastman;  
         struct mdoc      *mdoc;  
         struct mdoc      *lastmdoc;  
         enum outt         outtype;      /* Output devices... */  
         out_mdoc          outmdoc;  
         out_man           outman;  
         out_free          outfree;  
         void             *outdata;  
 };  };
   
 extern  void             *ascii_alloc(void);  static  int               koptions(int *, char *);
 extern  int               tree_mdoc(void *, const struct mdoc *);  static  int               moptions(int *, char *);
 extern  int               tree_man(void *, const struct man *);  static  void              mmsg(enum mandocerr, enum mandoclevel,
 extern  int               terminal_mdoc(void *, const struct mdoc *);                                  const char *, int, int, const char *);
 extern  int               terminal_man(void *, const struct man *);  static  void              parse(struct curparse *, int,
 extern  void              terminal_free(void *);                                  const char *, enum mandoclevel *);
   static  enum mandoclevel  passthrough(const char *, int, int);
   static  void              spawn_pager(void);
   static  int               toptions(struct curparse *, char *);
   static  void              usage(enum argmode) __attribute__((noreturn));
   static  void              version(void) __attribute__((noreturn));
   static  int               woptions(struct curparse *, char *);
   
 static  int               foptions(int *, char *);  static  const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
 static  int               toptions(enum outt *, char *);  static  char              help_arg[] = "help";
 static  int               moptions(enum intt *, char *);  static  char             *help_argv[] = {help_arg, NULL};
 static  int               woptions(int *, char *);  static  const char       *progname;
 static  int               merr(void *, int, int, const char *);  
 static  int               manwarn(void *, int, int, const char *);  
 static  int               mdocwarn(void *, int, int,  
                                 enum mdoc_warn, const char *);  
 static  int               ffile(struct buf *, struct buf *,  
                                 const char *, struct curparse *);  
 static  int               fdesc(struct buf *, struct buf *,  
                                 struct curparse *);  
 static  int               pset(const char *, int, struct curparse *,  
                                 struct man **, struct mdoc **);  
 static  struct man       *man_init(struct curparse *);  
 static  struct mdoc      *mdoc_init(struct curparse *);  
 __dead  static void       version(void);  
 __dead  static void       usage(void);  
   
 extern  char             *__progname;  
   
   
 int  int
 main(int argc, char *argv[])  main(int argc, char *argv[])
 {  {
         int              c, rc;  
         struct buf       ln, blk;  
         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              fd;
           int              show_usage;
           int              use_pager;
           int              synopsis_only;
           int              options;
           int              c;
   
         bzero(&curp, sizeof(struct curparse));          progname = strrchr(argv[0], '/');
           if (progname == NULL)
                   progname = argv[0];
           else
                   ++progname;
   
         curp.inttype = INTT_AUTO;          /* Search options. */
         curp.outtype = OUTT_ASCII;  
   
         /* LINTED */          memset(&paths, 0, sizeof(struct manpaths));
         while (-1 != (c = getopt(argc, argv, "f:m:VW:T:")))          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 if (strncmp(progname, "help", 4) == 0)
                   search.argmode = ARG_NAME;
           else
                   search.argmode = ARG_FILE;
   
           /* Parser and formatter options. */
   
           memset(&curp, 0, sizeof(struct curparse));
           curp.outtype = OUTT_LOCALE;
           curp.wlevel  = MANDOCLEVEL_FATAL;
           options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
           defos = NULL;
   
           use_pager = 1;
           show_usage = 0;
           synopsis_only = 0;
           outmode = OUTMODE_DEF;
   
           while (-1 != (c = getopt(argc, argv,
                           "aC:cfhI:iK:klM: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 ('T'):                  case 'c':
                         if ( ! toptions(&curp.outtype, optarg))                          use_pager = 0;
                                 return(EXIT_FAILURE);  
                         break;                          break;
                 case ('W'):                  case 'f':
                         if ( ! woptions(&curp.wflags, optarg))                          search.argmode = ARG_WORD;
                                 return(EXIT_FAILURE);  
                         break;                          break;
                 case ('V'):                  case 'h':
                           (void)strlcat(curp.outopts, "synopsis,", BUFSIZ);
                           synopsis_only = 1;
                           use_pager = 0;
                           outmode = OUTMODE_ALL;
                           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':
                           if ( ! koptions(&options, optarg))
                                   return((int)MANDOCLEVEL_BADARG);
                           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, ",", BUFSIZ);
                           break;
                   case 'S':
                           search.arch = optarg;
                           break;
                   case 's':
                           search.sec = optarg;
                           break;
                   case 'T':
                           if ( ! toptions(&curp, optarg))
                                   return((int)MANDOCLEVEL_BADARG);
                           break;
                   case 'W':
                           if ( ! woptions(&curp, optarg))
                                   return((int)MANDOCLEVEL_BADARG);
                           break;
                   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);
   
         bzero(&ln, sizeof(struct buf));          /* Postprocess options. */
         bzero(&blk, sizeof(struct buf));  
   
         rc = 1;          if (outmode == OUTMODE_DEF) {
                   switch (search.argmode) {
         if (NULL == *argv) {                  case ARG_FILE:
                 curp.file = "<stdin>";                          outmode = OUTMODE_ALL;
                 curp.fd = STDIN_FILENO;                          use_pager = 0;
                 if ( ! fdesc(&blk, &ln, &curp))                          break;
                         rc = 0;                  case ARG_NAME:
         }                          outmode = OUTMODE_ONE;
                           break;
         while (rc && *argv) {                  default:
                 if ( ! ffile(&blk, &ln, *argv, &curp))                          outmode = OUTMODE_LST;
                         rc = 0;                          break;
                 argv++;  
                 if (*argv && rc) {  
                         if (curp.lastman)  
                                 if ( ! man_reset(curp.lastman))  
                                         rc = 0;  
                         if (curp.lastmdoc)  
                                 if ( ! mdoc_reset(curp.lastmdoc))  
                                         rc = 0;  
                         curp.lastman = NULL;  
                         curp.lastmdoc = NULL;  
                 }                  }
         }          }
   
         if (blk.buf)          /* Parse arguments. */
                 free(blk.buf);  
         if (ln.buf)  
                 free(ln.buf);  
         if (curp.outfree)  
                 (*curp.outfree)(curp.outdata);  
         if (curp.mdoc)  
                 mdoc_free(curp.mdoc);  
         if (curp.man)  
                 man_free(curp.man);  
   
         return(rc ? EXIT_SUCCESS : EXIT_FAILURE);          argc -= optind;
 }          argv += optind;
   #if HAVE_SQLITE3
           resp = NULL;
   #endif
   
           /*
            * Quirks for help(1)
            * and for a man(1) section argument without -s.
            */
   
 __dead static void          if (search.argmode == ARG_NAME) {
 version(void)                  if (*progname == 'h') {
 {                          if (argc == 0) {
                                   argv = help_argv;
                                   argc = 1;
                           }
                   } else if (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(EXIT_SUCCESS);  
 }  
   
           /* man(1), whatis(1), apropos(1) */
   
 __dead 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...] "                  if (search.argmode == ARG_NAME &&
                         "[-mformat] [-Toutput] [-Werr...]\n",                      outmode == OUTMODE_ONE)
                         __progname);                          search.firstmatch = 1;
         exit(EXIT_FAILURE);  
 }  
   
                   /* Access the mandoc database. */
   
 static struct man *                  manpath_parse(&paths, conf_file, defpaths, auxpaths);
 man_init(struct curparse *curp)                  mansearch_setup(1);
 {                  if( ! mansearch(&search, &paths, argc, argv, &res, &sz))
         int              pflags;                          usage(search.argmode);
         struct man      *man;                  resp = res;
         struct man_cb    mancb;  
   
         mancb.man_err = merr;                  if (sz == 0) {
         mancb.man_warn = manwarn;                          if (search.argmode == ARG_NAME)
                                   fprintf(stderr, "%s: No entry for %s "
                                       "in the manual.\n", progname, argv[0]);
                           rc = MANDOCLEVEL_BADARG;
                           goto out;
                   }
   
         /* Defaults from mandoc.1. */                  /*
                    * For standard man(1) and -a output mode,
                    * prepare for copying filename pointers
                    * into the program parameter array.
                    */
   
         pflags = MAN_IGN_MACRO | MAN_IGN_ESCAPE | MAN_IGN_CHARS;                  if (outmode == OUTMODE_ONE) {
                           argc = 1;
                           best_prio = 10;
                   } else if (outmode == OUTMODE_ALL)
                           argc = (int)sz;
   
         if (curp->fflags & NO_IGN_MACRO)                  /* Iterate all matching manuals. */
                 pflags &= ~MAN_IGN_MACRO;  
         if (curp->fflags & NO_IGN_CHARS)  
                 pflags &= ~MAN_IGN_CHARS;  
         if (curp->fflags & NO_IGN_ESCAPE)  
                 pflags &= ~MAN_IGN_ESCAPE;  
   
         if (NULL == (man = man_alloc(curp, pflags, &mancb)))                  for (i = 0; i < sz; i++) {
                 warnx("memory exhausted");                          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;
                           }
                   }
   
         return(man);                  /*
 }                   * 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 (outmode == OUTMODE_FLN || outmode == OUTMODE_LST)
 static struct mdoc *                          goto out;
 mdoc_init(struct curparse *curp)  #else
 {                  fputs("mandoc: database support not compiled in\n",
         int              pflags;                      stderr);
         struct mdoc     *mdoc;                  return((int)MANDOCLEVEL_BADARG);
         struct mdoc_cb   mdoccb;  #endif
   
         mdoccb.mdoc_err = merr;  
         mdoccb.mdoc_warn = mdocwarn;  
   
         /* Defaults from mandoc.1. */  
   
         pflags = MDOC_IGN_MACRO | MDOC_IGN_ESCAPE | MDOC_IGN_CHARS;  
   
         if (curp->fflags & IGN_SCOPE)  
                 pflags |= MDOC_IGN_SCOPE;  
         if (curp->fflags & NO_IGN_ESCAPE)  
                 pflags &= ~MDOC_IGN_ESCAPE;  
         if (curp->fflags & NO_IGN_MACRO)  
                 pflags &= ~MDOC_IGN_MACRO;  
         if (curp->fflags & NO_IGN_CHARS)  
                 pflags &= ~MDOC_IGN_CHARS;  
   
         if (NULL == (mdoc = mdoc_alloc(curp, pflags, &mdoccb)))  
                 warnx("memory exhausted");  
   
         return(mdoc);  
 }  
   
   
 static int  
 ffile(struct buf *blk, struct buf *ln,  
                 const char *file, struct curparse *curp)  
 {  
         int              c;  
   
         curp->file = file;  
         if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {  
                 warn("%s", curp->file);  
                 return(0);  
         }          }
   
         c = fdesc(blk, ln, curp);          /* mandoc(1) */
   
         if (-1 == close(curp->fd))          if ( ! moptions(&options, auxpaths))
                 warn("%s", curp->file);                  return((int)MANDOCLEVEL_BADARG);
   
         return(c);          if (use_pager && isatty(STDOUT_FILENO))
 }                  spawn_pager();
   
           curp.mchars = mchars_alloc();
           curp.mp = mparse_alloc(options, curp.wlevel, mmsg,
               curp.mchars, defos);
   
 static int  
 fdesc(struct buf *blk, struct buf *ln, struct curparse *curp)  
 {  
         size_t           sz;  
         ssize_t          ssz;  
         struct stat      st;  
         int              j, i, pos, lnn, comment;  
         struct man      *man;  
         struct mdoc     *mdoc;  
   
         sz = BUFSIZ;  
         man = NULL;  
         mdoc = NULL;  
   
         /*          /*
          * Two buffers: ln and buf.  buf is the input buffer optimised           * Conditionally start up the lookaside buffer before parsing.
          * here for each file's block size.  ln is a line buffer.  Both  
          * growable, hence passed in by ptr-ptr.  
          */           */
           if (OUTT_MAN == curp.outtype)
                   mparse_keep(curp.mp);
   
         if (-1 == fstat(curp->fd, &st))          if (argc == 0)
                 warn("%s", curp->file);                  parse(&curp, STDIN_FILENO, "<stdin>", &rc);
         else if ((size_t)st.st_blksize > sz)  
                 sz = st.st_blksize;  
   
         if (sz > blk->sz) {          while (argc) {
                 blk->buf = realloc(blk->buf, sz);  #if HAVE_SQLITE3
                 if (NULL == blk->buf) {                  if (resp != NULL) {
                         warn("realloc");                          rc = mparse_open(curp.mp, &fd, resp->file);
                         return(0);                          if (fd == -1)
                                   /* nothing */;
                           else if (resp->form & FORM_SRC) {
                                   /* For .so only; ignore failure. */
                                   chdir(paths.paths[resp->ipath]);
                                   parse(&curp, fd, resp->file, &rc);
                           } else
                                   rc = passthrough(resp->file, fd,
                                       synopsis_only);
                           resp++;
                   } else
   #endif
                   {
                           rc = mparse_open(curp.mp, &fd, *argv++);
                           if (fd != -1)
                                   parse(&curp, fd, argv[-1], &rc);
                 }                  }
                 blk->sz = sz;  
         }  
   
         /* Fill buf with file blocksize. */                  if (mparse_wait(curp.mp) != MANDOCLEVEL_OK)
                           rc = MANDOCLEVEL_SYSERR;
   
         for (lnn = pos = comment = 0; ; ) {                  if (MANDOCLEVEL_OK != rc && curp.wstop)
                 if (-1 == (ssz = read(curp->fd, blk->buf, sz))) {  
                         warn("%s", curp->file);  
                         return(0);  
                 } else if (0 == ssz)  
                         break;                          break;
                   argc--;
           }
   
                 /* Parse the read block into partial or full lines. */          if (curp.outfree)
                   (*curp.outfree)(curp.outdata);
           mparse_free(curp.mp);
           mchars_free(curp.mchars);
   
                 for (i = 0; i < (int)ssz; i++) {  #if HAVE_SQLITE3
                         if (pos >= (int)ln->sz) {  out:
                                 ln->sz += 256; /* Step-size. */          if (search.argmode != ARG_FILE) {
                                 ln->buf = realloc(ln->buf, ln->sz);                  manpath_free(&paths);
                                 if (NULL == ln->buf) {                  mansearch_free(res, sz);
                                         warn("realloc");                  mansearch_setup(0);
                                         return(0);          }
                                 }  #endif
                         }  
   
                         if ('\n' != blk->buf[i]) {          free(defos);
                                 if (comment)  
                                         continue;  
                                 ln->buf[pos++] = blk->buf[i];  
   
                                 /* Handle in-line `\"' comments. */          return((int)rc);
   }
   
                                 if (1 == pos || '\"' != ln->buf[pos - 1])  static void
                                         continue;  version(void)
   {
   
                                 for (j = pos - 2; j >= 0; j--)          printf("mandoc %s\n", VERSION);
                                         if ('\\' != ln->buf[j])          exit((int)MANDOCLEVEL_OK);
                                                 break;  }
   
                                 if ( ! ((pos - 2 - j) % 2))  static void
                                         continue;  usage(enum argmode argmode)
   {
   
                                 comment = 1;          switch (argmode) {
                                 pos -= 2;          case ARG_FILE:
                                 continue;                  fputs("usage: mandoc [-acfhklV] [-Ios=name] "
                         }                      "[-Kencoding] [-mformat] [-Ooption]\n"
                       "\t      [-Toutput] [-Wlevel] [file ...]\n", stderr);
                   break;
           case ARG_NAME:
                   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 [-acfhklVw] [-C file] "
                       "[-M path] [-m path] [-O outkey] [-S arch]\n"
                       "\t      [-s section] name ...\n", stderr);
                   break;
           case ARG_EXPR:
                   fputs("usage: apropos [-acfhklVw] [-C file] "
                       "[-M path] [-m path] [-O outkey] [-S arch]\n"
                       "\t       [-s section] expression ...\n", stderr);
                   break;
           }
           exit((int)MANDOCLEVEL_BADARG);
   }
   
                         /* Handle escaped `\\n' newlines. */  static void
   parse(struct curparse *curp, int fd, const char *file,
           enum mandoclevel *level)
   {
           enum mandoclevel  rc;
           struct mdoc      *mdoc;
           struct man       *man;
   
                         if (pos > 0 && 0 == comment &&          /* Begin by parsing the file itself. */
                                         '\\' == ln->buf[pos - 1]) {  
                                 for (j = pos - 1; j >= 0; j--)  
                                         if ('\\' != ln->buf[j])  
                                                 break;  
                                 if ( ! ((pos - j) % 2)) {  
                                         pos--;  
                                         lnn++;  
                                         continue;  
                                 }  
                         }  
   
                         ln->buf[pos] = 0;          assert(file);
                         lnn++;          assert(fd >= -1);
   
                         /* If unset, assign parser in pset(). */          rc = mparse_readfd(curp->mp, fd, file);
   
                         if ( ! (man || mdoc) && ! pset(ln->buf,          /* Stop immediately if the parse has failed. */
                                                 pos, curp, &man, &mdoc))  
                                 return(0);  
   
                         pos = comment = 0;          if (MANDOCLEVEL_FATAL <= rc)
                   goto cleanup;
   
                         /* Pass down into parsers. */          /*
            * With -Wstop and warnings or errors of at least the requested
            * level, do not produce output.
            */
   
                         if (man && ! man_parseln(man, lnn, ln->buf))          if (MANDOCLEVEL_OK != rc && curp->wstop)
                                 return(0);                  goto cleanup;
                         if (mdoc && ! mdoc_parseln(mdoc, lnn, ln->buf))  
                                 return(0);  
                 }  
         }  
   
         /* NOTE a parser may not have been assigned, yet. */  
   
         if ( ! (man || mdoc)) {  
                 warnx("%s: not a manual", curp->file);  
                 return(0);  
         }  
   
         if (mdoc && ! mdoc_endparse(mdoc))  
                 return(0);  
         if (man && ! man_endparse(man))  
                 return(0);  
   
         /* 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_TREE):                  case OUTT_HTML:
                           curp->outdata = html_alloc(curp->mchars,
                               curp->outopts);
                           curp->outfree = html_free;
                           break;
                   case OUTT_UTF8:
                           curp->outdata = utf8_alloc(curp->mchars,
                               curp->outopts);
                           curp->outfree = ascii_free;
                           break;
                   case OUTT_LOCALE:
                           curp->outdata = locale_alloc(curp->mchars,
                               curp->outopts);
                           curp->outfree = ascii_free;
                           break;
                   case OUTT_ASCII:
                           curp->outdata = ascii_alloc(curp->mchars,
                               curp->outopts);
                           curp->outfree = ascii_free;
                           break;
                   case OUTT_PDF:
                           curp->outdata = pdf_alloc(curp->mchars,
                               curp->outopts);
                           curp->outfree = pspdf_free;
                           break;
                   case OUTT_PS:
                           curp->outdata = ps_alloc(curp->mchars,
                               curp->outopts);
                           curp->outfree = pspdf_free;
                           break;
                   default:
                           break;
                   }
   
                   switch (curp->outtype) {
                   case OUTT_HTML:
                           curp->outman = html_man;
                           curp->outmdoc = html_mdoc;
                           break;
                   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();                          /* 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)
                 if ( ! (*curp->outman)(curp->outdata, man))                  (*curp->outman)(curp->outdata, man);
                         return(0);  
         if (mdoc && curp->outmdoc)          if (mdoc && curp->outmdoc)
                 if ( ! (*curp->outmdoc)(curp->outdata, mdoc))                  (*curp->outmdoc)(curp->outdata, mdoc);
                         return(0);  
   
         return(1);   cleanup:
 }  
   
           mparse_reset(curp->mp);
   
 static int          if (*level < rc)
 pset(const char *buf, int pos, struct curparse *curp,                  *level = rc;
                 struct man **man, struct mdoc **mdoc)  }
   
   static enum mandoclevel
   passthrough(const char *file, int fd, int synopsis_only)
 {  {
         int              i;          const char       synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
           const char       synr[] = "SYNOPSIS";
   
         /*          FILE            *stream;
          * Try to intuit which kind of manual parser should be used.  If          const char      *syscall;
          * passed in by command-line (-man, -mdoc), then use that          char            *line;
          * explicitly.  If passed as -mandoc, then try to guess from the          size_t           len, off;
          * line: either skip dot-lines, use -mdoc when finding `.Dt', or          ssize_t          nw;
          * default to -man, which is more lenient.          int              print;
          */  
   
         if (buf[0] == '.') {          if ((stream = fdopen(fd, "r")) == NULL) {
                 for (i = 1; buf[i]; i++)                  close(fd);
                         if (' ' != buf[i] && '\t' != buf[i])                  syscall = "fdopen";
                                 break;                  goto fail;
                 if (0 == buf[i])  
                         return(1);  
         }          }
   
         switch (curp->inttype) {          print = 0;
         case (INTT_MDOC):          while ((line = fgetln(stream, &len)) != NULL) {
                 if (NULL == curp->mdoc)                  if (synopsis_only) {
                         curp->mdoc = mdoc_init(curp);                          if (print) {
                 if (NULL == (*mdoc = curp->mdoc))                                  if ( ! isspace((unsigned char)*line))
                         return(0);                                          goto done;
                 curp->lastmdoc = *mdoc;                                  while (len &&
                 return(1);                                      isspace((unsigned char)*line)) {
         case (INTT_MAN):                                          line++;
                 if (NULL == curp->man)                                          len--;
                         curp->man = man_init(curp);                                  }
                 if (NULL == (*man = curp->man))                          } else {
                         return(0);                                  if ((len == sizeof(synb) &&
                 curp->lastman = *man;                                       ! strncmp(line, synb, len - 1)) ||
                 return(1);                                      (len == sizeof(synr) &&
         default:                                       ! strncmp(line, synr, len - 1)))
                 break;                                          print = 1;
                                   continue;
                           }
                   }
                   for (off = 0; off < len; off += nw)
                           if ((nw = write(STDOUT_FILENO, line + off,
                               len - off)) == -1 || nw == 0) {
                                   fclose(stream);
                                   syscall = "write";
                                   goto fail;
                           }
         }          }
   
         if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3))  {          if (ferror(stream)) {
                 if (NULL == curp->mdoc)                  fclose(stream);
                         curp->mdoc = mdoc_init(curp);                  syscall = "fgetln";
                 if (NULL == (*mdoc = curp->mdoc))                  goto fail;
                         return(0);          }
                 curp->lastmdoc = *mdoc;  
                 return(1);  
         }  
   
         if (NULL == curp->man)  done:
                 curp->man = man_init(curp);          fclose(stream);
         if (NULL == (*man = curp->man))          return(MANDOCLEVEL_OK);
   
   fail:
           fprintf(stderr, "%s: %s: SYSERR: %s: %s",
               progname, file, syscall, strerror(errno));
           return(MANDOCLEVEL_SYSERR);
   }
   
   static int
   koptions(int *options, char *arg)
   {
   
           if ( ! strcmp(arg, "utf-8")) {
                   *options |=  MPARSE_UTF8;
                   *options &= ~MPARSE_LATIN1;
           } else if ( ! strcmp(arg, "iso-8859-1")) {
                   *options |=  MPARSE_LATIN1;
                   *options &= ~MPARSE_UTF8;
           } else if ( ! strcmp(arg, "us-ascii")) {
                   *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
           } else {
                   fprintf(stderr, "%s: -K%s: Bad argument\n",
                       progname, arg);
                 return(0);                  return(0);
         curp->lastman = *man;          }
         return(1);          return(1);
 }  }
   
   
 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 {
                 warnx("bad argument: -m%s", arg);                  fprintf(stderr, "%s: -m%s: Bad argument\n",
                       progname, arg);
                 return(0);                  return(0);
         }          }
   
         return(1);          return(1);
 }  }
   
   
 static int  static int
 toptions(enum outt *tflags, char *arg)  toptions(struct curparse *curp, char *arg)
 {  {
   
         if (0 == strcmp(arg, "ascii"))          if (0 == strcmp(arg, "ascii"))
                 *tflags = OUTT_ASCII;                  curp->outtype = OUTT_ASCII;
         else if (0 == strcmp(arg, "lint"))          else if (0 == strcmp(arg, "lint")) {
                 *tflags = OUTT_LINT;                  curp->outtype = OUTT_LINT;
         else if (0 == strcmp(arg, "tree"))                  curp->wlevel  = MANDOCLEVEL_WARNING;
                 *tflags = OUTT_TREE;          } else if (0 == strcmp(arg, "tree"))
                   curp->outtype = OUTT_TREE;
           else if (0 == strcmp(arg, "man"))
                   curp->outtype = OUTT_MAN;
           else if (0 == strcmp(arg, "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"))
                   curp->outtype = OUTT_HTML;
           else if (0 == strcmp(arg, "ps"))
                   curp->outtype = OUTT_PS;
           else if (0 == strcmp(arg, "pdf"))
                   curp->outtype = OUTT_PDF;
         else {          else {
                 warnx("bad argument: -T%s", arg);                  fprintf(stderr, "%s: -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;
         char            *toks[6];          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] = "no-ign-chars";          toks[3] = "error";
         toks[4] = "strict";          toks[4] = "fatal";
         toks[5] = NULL;          toks[5] = NULL;
   
         while (*arg) {          while (*arg) {
                 o = arg;                  o = arg;
                 switch (getsubopt(&arg, toks, &v)) {                  switch (getsubopt(&arg, UNCONST(toks), &v)) {
                 case (0):                  case 0:
                         *fflags |= IGN_SCOPE;                          curp->wstop = 1;
                         break;                          break;
                 case (1):                  case 1:
                         *fflags |= NO_IGN_ESCAPE;                          /* FALLTHROUGH */
                   case 2:
                           curp->wlevel = MANDOCLEVEL_WARNING;
                         break;                          break;
                 case (2):                  case 3:
                         *fflags |= NO_IGN_MACRO;                          curp->wlevel = MANDOCLEVEL_ERROR;
                         break;                          break;
                 case (3):                  case 4:
                         *fflags |= NO_IGN_CHARS;                          curp->wlevel = MANDOCLEVEL_FATAL;
                         break;                          break;
                 case (4):  
                         *fflags |= NO_IGN_ESCAPE |  
                                    NO_IGN_MACRO | NO_IGN_CHARS;  
                         break;  
                 default:                  default:
                         warnx("bad argument: -f%s", o);                          fprintf(stderr, "%s: -W%s: Bad argument\n",
                               progname, o);
                         return(0);                          return(0);
                 }                  }
         }          }
Line 592  foptions(int *fflags, char *arg)
Line 775  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;
         char            *toks[5];  
   
         toks[0] = "all";          fprintf(stderr, "%s: %s:", progname, file);
         toks[1] = "compat";  
         toks[2] = "syntax";  
         toks[3] = "error";  
         toks[4] = NULL;  
   
         while (*arg) {          if (line)
                 o = arg;                  fprintf(stderr, "%d:%d:", line, col + 1);
                 switch (getsubopt(&arg, toks, &v)) {  
                 case (0):  
                         *wflags |= WARN_WALL;  
                         break;  
                 case (1):  
                         *wflags |= WARN_WCOMPAT;  
                         break;  
                 case (2):  
                         *wflags |= WARN_WSYNTAX;  
                         break;  
                 case (3):  
                         *wflags |= WARN_WERR;  
                         break;  
                 default:  
                         warnx("bad argument: -W%s", 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);
         warnx("%s:%d: error: %s (column %d)",  
                         curp->file, line, msg, col);  
   
         return(0);  
 }  }
   
   static void
 static int  spawn_pager(void)
 mdocwarn(void *arg, int line, int col,  
                 enum mdoc_warn type, const char *msg)  
 {  {
         struct curparse *curp;  #define MAX_PAGER_ARGS 16
         char            *wtype;          char            *argv[MAX_PAGER_ARGS];
           const char      *pager;
           char            *cp;
           int              fildes[2];
           int              argc;
   
         curp = (struct curparse *)arg;          if (pipe(fildes) == -1) {
         wtype = NULL;                  fprintf(stderr, "%s: pipe: %s\n",
                       progname, strerror(errno));
                   return;
           }
   
         switch (type) {          switch (fork()) {
         case (WARN_COMPAT):          case -1:
                 wtype = "compat";                  fprintf(stderr, "%s: fork: %s\n",
                 if (curp->wflags & WARN_WCOMPAT)                      progname, strerror(errno));
                         break;                  exit((int)MANDOCLEVEL_SYSERR);
                 return(1);          case 0:
         case (WARN_SYNTAX):                  close(fildes[0]);
                 wtype = "syntax";                  if (dup2(fildes[1], STDOUT_FILENO) == -1) {
                 if (curp->wflags & WARN_WSYNTAX)                          fprintf(stderr, "%s: dup output: %s\n",
                         break;                              progname, strerror(errno));
                 return(1);                          exit((int)MANDOCLEVEL_SYSERR);
                   }
                   return;
           default:
                   break;
         }          }
   
         assert(wtype);          /* The original process becomes the pager. */
         warnx("%s:%d: %s warning: %s (column %d)",  
                         curp->file, line, wtype, msg, col);  
   
         if ( ! (curp->wflags & WARN_WERR))          close(fildes[1]);
                 return(1);          if (dup2(fildes[0], STDIN_FILENO) == -1) {
                   fprintf(stderr, "%s: dup input: %s\n",
         warnx("considering warnings as errors");                      progname, strerror(errno));
         return(0);                  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);
   
 static int          /*
 manwarn(void *arg, int line, int col, const char *msg)           * Parse the pager command into words.
 {           * Intentionally do not do anything fancy here.
         struct curparse *curp;           */
   
         curp = (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;
   
         if ( ! (curp->wflags & WARN_WSYNTAX))          /* Hand over to the pager. */
                 return(1);  
   
         warnx("%s:%d: syntax warning: %s (column %d)",          execvp(argv[0], argv);
                         curp->file, line, msg, col);          fprintf(stderr, "%s: exec: %s\n",
               progname, strerror(errno));
         if ( ! (curp->wflags & WARN_WERR))          exit((int)MANDOCLEVEL_SYSERR);
                 return(1);  
   
         warnx("considering warnings as errors");  
         return(0);  
 }  }
Legend:
Removed from v.1.34  
changed lines
  Added in v.1.202
CVSweb