]> git.cameronkatri.com Git - mandoc.git/blobdiff - main.c
move man(7) validation into the dedicated validation phase, too
[mandoc.git] / main.c
diff --git a/main.c b/main.c
index ca30cf4de59c0af84fac0bcea955a1e65de39d7b..31dc9994cc17c2b4b690be72e103ec4aa67dd54d 100644 (file)
--- a/main.c
+++ b/main.c
@@ -1,4 +1,4 @@
-/*     $Id: main.c,v 1.242 2015/07/19 06:05:16 schwarze Exp $ */
+/*     $Id: main.c,v 1.253 2015/10/22 21:54:23 schwarze Exp $ */
 /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010-2012, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
@@ -24,7 +24,7 @@
 
 #include <assert.h>
 #include <ctype.h>
-#include <errno.h>
+#include <err.h>
 #include <fcntl.h>
 #include <glob.h>
 #include <signal.h>
@@ -59,10 +59,6 @@ enum outmode {
        OUTMODE_ONE
 };
 
-typedef        void            (*out_mdoc)(void *, const struct roff_man *);
-typedef        void            (*out_man)(void *, const struct roff_man *);
-typedef        void            (*out_free)(void *);
-
 enum   outt {
        OUTT_ASCII = 0, /* -Tascii */
        OUTT_LOCALE,    /* -Tlocale */
@@ -77,13 +73,9 @@ enum outt {
 
 struct curparse {
        struct mparse    *mp;
-       struct mchars    *mchars;       /* character table */
        enum mandoclevel  wlevel;       /* ignore messages below this */
        int               wstop;        /* stop after a file with a warning */
        enum outt         outtype;      /* which output to use */
-       out_mdoc          outmdoc;      /* mdoc output ptr */
-       out_man           outman;       /* man output ptr */
-       out_free          outfree;      /* free output ptr */
        void             *outdata;      /* data for output */
        struct manoutput *outopts;      /* output options */
 };
@@ -95,7 +87,6 @@ static        int               fs_lookup(const struct manpaths *,
 static void              fs_search(const struct mansearch *,
                                const struct manpaths *, int, char**,
                                struct manpage **, size_t *);
-static void              handle_sigpipe(int);
 static int               koptions(int *, char *);
 #if HAVE_SQLITE3
 int                      mandocdb(int, char**);
@@ -105,15 +96,16 @@ static     void              mmsg(enum mandocerr, enum mandoclevel,
                                const char *, int, int, const char *);
 static void              parse(struct curparse *, int, const char *);
 static void              passthrough(const char *, int, int);
-static pid_t             spawn_pager(void);
+static pid_t             spawn_pager(struct tag_files *);
 static int               toptions(struct curparse *, char *);
 static void              usage(enum argmode) __attribute__((noreturn));
 static int               woptions(struct curparse *, char *);
 
+extern char             *__progname;
+
 static const int sec_prios[] = {1, 4, 5, 8, 6, 3, 7, 2, 9};
 static char              help_arg[] = "help";
 static char             *help_argv[] = {help_arg, NULL};
-static const char       *progname;
 static enum mandoclevel  rc;
 
 
@@ -123,6 +115,7 @@ main(int argc, char *argv[])
        struct manconf   conf;
        struct curparse  curp;
        struct mansearch search;
+       struct tag_files *tag_files;
        char            *auxpaths;
        char            *defos;
        unsigned char   *uc;
@@ -136,19 +129,21 @@ main(int argc, char *argv[])
        int              fd;
        int              show_usage;
        int              options;
+       int              use_pager;
        int              c;
-       pid_t            pager_pid;  /* 0: don't use; 1: not yet spawned. */
 
+#if !HAVE_PROGNAME
        if (argc < 1)
-               progname = "mandoc";
-       else if ((progname = strrchr(argv[0], '/')) == NULL)
-               progname = argv[0];
+               __progname = mandoc_strdup("mandoc");
+       else if ((__progname = strrchr(argv[0], '/')) == NULL)
+               __progname = argv[0];
        else
-               ++progname;
+               ++__progname;
+#endif
 
 #if HAVE_SQLITE3
-       if (strcmp(progname, BINM_MAKEWHATIS) == 0)
-               return(mandocdb(argc, argv));
+       if (strcmp(__progname, BINM_MAKEWHATIS) == 0)
+               return mandocdb(argc, argv);
 #endif
 
        /* Search options. */
@@ -160,13 +155,13 @@ main(int argc, char *argv[])
        memset(&search, 0, sizeof(struct mansearch));
        search.outkey = "Nd";
 
-       if (strcmp(progname, BINM_MAN) == 0)
+       if (strcmp(__progname, BINM_MAN) == 0)
                search.argmode = ARG_NAME;
-       else if (strcmp(progname, BINM_APROPOS) == 0)
+       else if (strcmp(__progname, BINM_APROPOS) == 0)
                search.argmode = ARG_EXPR;
-       else if (strcmp(progname, BINM_WHATIS) == 0)
+       else if (strcmp(__progname, BINM_WHATIS) == 0)
                search.argmode = ARG_WORD;
-       else if (strncmp(progname, "help", 4) == 0)
+       else if (strncmp(__progname, "help", 4) == 0)
                search.argmode = ARG_NAME;
        else
                search.argmode = ARG_FILE;
@@ -180,7 +175,8 @@ main(int argc, char *argv[])
        options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
        defos = NULL;
 
-       pager_pid = 1;
+       use_pager = 1;
+       tag_files = NULL;
        show_usage = 0;
        outmode = OUTMODE_DEF;
 
@@ -194,28 +190,24 @@ main(int argc, char *argv[])
                        conf_file = optarg;
                        break;
                case 'c':
-                       pager_pid = 0;
+                       use_pager = 0;
                        break;
                case 'f':
                        search.argmode = ARG_WORD;
                        break;
                case 'h':
                        conf.output.synopsisonly = 1;
-                       pager_pid = 0;
+                       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);
+                               warnx("-I %s: Bad argument", optarg);
+                               return (int)MANDOCLEVEL_BADARG;
                        }
                        if (defos) {
-                               fprintf(stderr,
-                                   "%s: -I %s: Duplicate argument\n",
-                                   progname, optarg);
-                               return((int)MANDOCLEVEL_BADARG);
+                               warnx("-I %s: Duplicate argument", optarg);
+                               return (int)MANDOCLEVEL_BADARG;
                        }
                        defos = mandoc_strdup(optarg + 3);
                        break;
@@ -224,7 +216,7 @@ main(int argc, char *argv[])
                        break;
                case 'K':
                        if ( ! koptions(&options, optarg))
-                               return((int)MANDOCLEVEL_BADARG);
+                               return (int)MANDOCLEVEL_BADARG;
                        break;
                case 'k':
                        search.argmode = ARG_EXPR;
@@ -253,11 +245,11 @@ main(int argc, char *argv[])
                        break;
                case 'T':
                        if ( ! toptions(&curp, optarg))
-                               return((int)MANDOCLEVEL_BADARG);
+                               return (int)MANDOCLEVEL_BADARG;
                        break;
                case 'W':
                        if ( ! woptions(&curp, optarg))
-                               return((int)MANDOCLEVEL_BADARG);
+                               return (int)MANDOCLEVEL_BADARG;
                        break;
                case 'w':
                        outmode = OUTMODE_FLN;
@@ -277,7 +269,7 @@ main(int argc, char *argv[])
                switch (search.argmode) {
                case ARG_FILE:
                        outmode = OUTMODE_ALL;
-                       pager_pid = 0;
+                       use_pager = 0;
                        break;
                case ARG_NAME:
                        outmode = OUTMODE_ONE;
@@ -288,6 +280,11 @@ main(int argc, char *argv[])
                }
        }
 
+       if (outmode == OUTMODE_FLN ||
+           outmode == OUTMODE_LST ||
+           !isatty(STDOUT_FILENO))
+               use_pager = 0;
+
        /* Parse arguments. */
 
        if (argc > 0) {
@@ -302,7 +299,7 @@ main(int argc, char *argv[])
         */
 
        if (search.argmode == ARG_NAME) {
-               if (*progname == 'h') {
+               if (*__progname == 'h') {
                        if (argc == 0) {
                                argv = help_argv;
                                argc = 1;
@@ -348,7 +345,7 @@ main(int argc, char *argv[])
                if (search.argmode != ARG_NAME) {
                        fputs("mandoc: database support not compiled in\n",
                            stderr);
-                       return((int)MANDOCLEVEL_BADARG);
+                       return (int)MANDOCLEVEL_BADARG;
                }
                sz = 0;
 #endif
@@ -358,9 +355,7 @@ main(int argc, char *argv[])
                                fs_search(&search, &conf.manpath,
                                    argc, argv, &res, &sz);
                        else
-                               fprintf(stderr,
-                                   "%s: nothing appropriate\n",
-                                   progname);
+                               warnx("nothing appropriate");
                }
 
                if (sz == 0) {
@@ -417,14 +412,10 @@ main(int argc, char *argv[])
        /* mandoc(1) */
 
        if (search.argmode == ARG_FILE && ! moptions(&options, auxpaths))
-               return((int)MANDOCLEVEL_BADARG);
+               return (int)MANDOCLEVEL_BADARG;
 
-       if (pager_pid == 1 && isatty(STDOUT_FILENO) == 0)
-               pager_pid = 0;
-
-       curp.mchars = mchars_alloc();
-       curp.mp = mparse_alloc(options, curp.wlevel, mmsg,
-           curp.mchars, defos);
+       mchars_alloc();
+       curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);
 
        /*
         * Conditionally start up the lookaside buffer before parsing.
@@ -433,8 +424,8 @@ main(int argc, char *argv[])
                mparse_keep(curp.mp);
 
        if (argc < 1) {
-               if (pager_pid == 1)
-                       pager_pid = spawn_pager();
+               if (use_pager)
+                       tag_files = tag_init();
                parse(&curp, STDIN_FILENO, "<stdin>");
        }
 
@@ -445,8 +436,10 @@ main(int argc, char *argv[])
                        rc = rctmp;
 
                if (fd != -1) {
-                       if (pager_pid == 1)
-                               pager_pid = spawn_pager();
+                       if (use_pager) {
+                               tag_files = tag_init();
+                               use_pager = 0;
+                       }
 
                        if (resp == NULL)
                                parse(&curp, fd, *argv);
@@ -473,10 +466,26 @@ main(int argc, char *argv[])
                        mparse_reset(curp.mp);
        }
 
-       if (curp.outfree)
-               (*curp.outfree)(curp.outdata);
+       if (curp.outdata != NULL) {
+               switch (curp.outtype) {
+               case OUTT_HTML:
+                       html_free(curp.outdata);
+                       break;
+               case OUTT_UTF8:
+               case OUTT_LOCALE:
+               case OUTT_ASCII:
+                       ascii_free(curp.outdata);
+                       break;
+               case OUTT_PDF:
+               case OUTT_PS:
+                       pspdf_free(curp.outdata);
+                       break;
+               default:
+                       break;
+               }
+       }
        mparse_free(curp.mp);
-       mchars_free(curp.mchars);
+       mchars_free();
 
 out:
        if (search.argmode != ARG_FILE) {
@@ -490,19 +499,18 @@ out:
        free(defos);
 
        /*
-        * If a pager is attached, flush the pipe leading to it
-        * and signal end of file such that the user can browse
-        * to the end.  Then wait for the user to close the pager.
+        * When using a pager, finish writing both temporary files,
+        * fork it, wait for the user to close it, and clean up.
         */
 
-       if (pager_pid != 0 && pager_pid != 1) {
+       if (tag_files != NULL) {
                fclose(stdout);
                tag_write();
-               waitpid(pager_pid, NULL, 0);
+               waitpid(spawn_pager(tag_files), NULL, 0);
                tag_unlink();
        }
 
-       return((int)rc);
+       return (int)rc;
 }
 
 static void
@@ -573,19 +581,18 @@ fs_lookup(const struct manpaths *paths, size_t ipath,
            paths->paths[ipath], sec, name);
        globres = glob(file, 0, NULL, &globinfo);
        if (globres != 0 && globres != GLOB_NOMATCH)
-               fprintf(stderr, "%s: %s: glob: %s\n",
-                   progname, file, strerror(errno));
+               warn("%s: glob", file);
        free(file);
        if (globres == 0)
                file = mandoc_strdup(*globinfo.gl_pathv);
        globfree(&globinfo);
        if (globres != 0)
-               return(0);
+               return 0;
 
 found:
 #if HAVE_SQLITE3
-       fprintf(stderr, "%s: outdated mandoc.db lacks %s(%s) entry, run "
-           "makewhatis %s\n", progname, name, sec, paths->paths[ipath]);
+       warnx("outdated mandoc.db lacks %s(%s) entry, run makewhatis %s\n",
+           name, sec, paths->paths[ipath]);
 #endif
        *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
        page = *res + (*ressz - 1);
@@ -596,7 +603,7 @@ found:
        page->bits = NAME_FILE & NAME_MASK;
        page->sec = (*sec >= '1' && *sec <= '9') ? *sec - '1' + 1 : 10;
        page->form = form;
-       return(1);
+       return 1;
 }
 
 static void
@@ -627,9 +634,7 @@ fs_search(const struct mansearch *cfg, const struct manpaths *paths,
                                        return;
                }
                if (*ressz == lastsz)
-                       fprintf(stderr,
-                           "%s: No entry for %s in the manual.\n",
-                           progname, *argv);
+                       warnx("No entry for %s in the manual.", *argv);
                lastsz = *ressz;
                argv++;
                argc--;
@@ -661,82 +666,83 @@ parse(struct curparse *curp, int fd, const char *file)
 
        /* If unset, allocate output dev now (if applicable). */
 
-       if ( ! (curp->outman && curp->outmdoc)) {
+       if (curp->outdata == NULL) {
                switch (curp->outtype) {
                case OUTT_HTML:
-                       curp->outdata = html_alloc(curp->mchars,
-                           curp->outopts);
-                       curp->outfree = html_free;
+                       curp->outdata = html_alloc(curp->outopts);
                        break;
                case OUTT_UTF8:
-                       curp->outdata = utf8_alloc(curp->mchars,
-                           curp->outopts);
-                       curp->outfree = ascii_free;
+                       curp->outdata = utf8_alloc(curp->outopts);
                        break;
                case OUTT_LOCALE:
-                       curp->outdata = locale_alloc(curp->mchars,
-                           curp->outopts);
-                       curp->outfree = ascii_free;
+                       curp->outdata = locale_alloc(curp->outopts);
                        break;
                case OUTT_ASCII:
-                       curp->outdata = ascii_alloc(curp->mchars,
-                           curp->outopts);
-                       curp->outfree = ascii_free;
+                       curp->outdata = ascii_alloc(curp->outopts);
                        break;
                case OUTT_PDF:
-                       curp->outdata = pdf_alloc(curp->mchars,
-                           curp->outopts);
-                       curp->outfree = pspdf_free;
+                       curp->outdata = pdf_alloc(curp->outopts);
                        break;
                case OUTT_PS:
-                       curp->outdata = ps_alloc(curp->mchars,
-                           curp->outopts);
-                       curp->outfree = pspdf_free;
+                       curp->outdata = ps_alloc(curp->outopts);
                        break;
                default:
                        break;
                }
+       }
+
+       mparse_result(curp->mp, &man, NULL);
+
+       /* Execute the out device, if it exists. */
 
+       if (man == NULL)
+               return;
+       if (man->macroset == MACROSET_MDOC) {
+               mdoc_validate(man);
                switch (curp->outtype) {
                case OUTT_HTML:
-                       curp->outman = html_man;
-                       curp->outmdoc = html_mdoc;
+                       html_mdoc(curp->outdata, man);
                        break;
                case OUTT_TREE:
-                       curp->outman = tree_man;
-                       curp->outmdoc = tree_mdoc;
+                       tree_mdoc(curp->outdata, man);
                        break;
                case OUTT_MAN:
-                       curp->outmdoc = man_mdoc;
-                       curp->outman = man_man;
+                       man_mdoc(curp->outdata, man);
                        break;
                case OUTT_PDF:
-                       /* FALLTHROUGH */
                case OUTT_ASCII:
-                       /* FALLTHROUGH */
                case OUTT_UTF8:
-                       /* FALLTHROUGH */
                case OUTT_LOCALE:
-                       /* FALLTHROUGH */
                case OUTT_PS:
-                       curp->outman = terminal_man;
-                       curp->outmdoc = terminal_mdoc;
+                       terminal_mdoc(curp->outdata, man);
+                       break;
+               default:
+                       break;
+               }
+       }
+       if (man->macroset == MACROSET_MAN) {
+               man_validate(man);
+               switch (curp->outtype) {
+               case OUTT_HTML:
+                       html_man(curp->outdata, man);
+                       break;
+               case OUTT_TREE:
+                       tree_man(curp->outdata, man);
+                       break;
+               case OUTT_MAN:
+                       man_man(curp->outdata, man);
+                       break;
+               case OUTT_PDF:
+               case OUTT_ASCII:
+               case OUTT_UTF8:
+               case OUTT_LOCALE:
+               case OUTT_PS:
+                       terminal_man(curp->outdata, man);
                        break;
                default:
                        break;
                }
        }
-
-       mparse_result(curp->mp, &man, NULL);
-
-       /* Execute the out device, if it exists. */
-
-       if (man == NULL)
-               return;
-       if (curp->outmdoc != NULL && man->macroset == MACROSET_MDOC)
-               (*curp->outmdoc)(curp->outdata, man);
-       if (curp->outman != NULL && man->macroset == MACROSET_MAN)
-               (*curp->outman)(curp->outdata, man);
 }
 
 static void
@@ -800,8 +806,7 @@ done:
        return;
 
 fail:
-       fprintf(stderr, "%s: %s: SYSERR: %s: %s",
-           progname, file, syscall, strerror(errno));
+       warn("%s: SYSERR: %s", file, syscall);
        if (rc < MANDOCLEVEL_SYSERR)
                rc = MANDOCLEVEL_SYSERR;
 }
@@ -819,11 +824,10 @@ koptions(int *options, char *arg)
        } else if ( ! strcmp(arg, "us-ascii")) {
                *options &= ~(MPARSE_UTF8 | MPARSE_LATIN1);
        } else {
-               fprintf(stderr, "%s: -K %s: Bad argument\n",
-                   progname, arg);
-               return(0);
+               warnx("-K %s: Bad argument", arg);
+               return 0;
        }
-       return(1);
+       return 1;
 }
 
 static int
@@ -839,12 +843,11 @@ moptions(int *options, char *arg)
        else if (0 == strcmp(arg, "an"))
                *options |= MPARSE_MAN;
        else {
-               fprintf(stderr, "%s: -m %s: Bad argument\n",
-                   progname, arg);
-               return(0);
+               warnx("-m %s: Bad argument", arg);
+               return 0;
        }
 
-       return(1);
+       return 1;
 }
 
 static int
@@ -873,12 +876,11 @@ toptions(struct curparse *curp, char *arg)
        else if (0 == strcmp(arg, "pdf"))
                curp->outtype = OUTT_PDF;
        else {
-               fprintf(stderr, "%s: -T %s: Bad argument\n",
-                   progname, arg);
-               return(0);
+               warnx("-T %s: Bad argument", arg);
+               return 0;
        }
 
-       return(1);
+       return 1;
 }
 
 static int
@@ -902,7 +904,6 @@ woptions(struct curparse *curp, char *arg)
                        curp->wstop = 1;
                        break;
                case 1:
-                       /* FALLTHROUGH */
                case 2:
                        curp->wlevel = MANDOCLEVEL_WARNING;
                        break;
@@ -916,13 +917,12 @@ woptions(struct curparse *curp, char *arg)
                        curp->wlevel = MANDOCLEVEL_BADARG;
                        break;
                default:
-                       fprintf(stderr, "%s: -W %s: Bad argument\n",
-                           progname, o);
-                       return(0);
+                       warnx("-W %s: Bad argument", o);
+                       return 0;
                }
        }
 
-       return(1);
+       return 1;
 }
 
 static void
@@ -931,7 +931,7 @@ mmsg(enum mandocerr t, enum mandoclevel lvl,
 {
        const char      *mparse_msg;
 
-       fprintf(stderr, "%s: %s:", progname, file);
+       fprintf(stderr, "%s: %s:", __progname, file);
 
        if (line)
                fprintf(stderr, "%d:%d:", line, col + 1);
@@ -947,22 +947,14 @@ mmsg(enum mandocerr t, enum mandoclevel lvl,
        fputc('\n', stderr);
 }
 
-static void
-handle_sigpipe(int signum)
-{
-
-       exit((int)rc);
-}
-
 static pid_t
-spawn_pager(void)
+spawn_pager(struct tag_files *tag_files)
 {
 #define MAX_PAGER_ARGS 16
        char            *argv[MAX_PAGER_ARGS];
        const char      *pager;
        char            *cp;
        size_t           cmdlen;
-       int              fildes[2];
        int              argc;
        pid_t            pager_pid;
 
@@ -991,59 +983,33 @@ spawn_pager(void)
                        break;
        }
 
-       /* Read all text right away and use the tag file. */
+       /* For more(1) and less(1), use the tag file. */
 
        if ((cmdlen = strlen(argv[0])) >= 4) {
                cp = argv[0] + cmdlen - 4;
-               if (strcmp(cp, "less") == 0 ||
-                   strcmp(cp, "more") == 0) {
-                       tag_init();
-                       argv[argc++] = mandoc_strdup("+G1G");
+               if (strcmp(cp, "less") == 0 || strcmp(cp, "more") == 0) {
                        argv[argc++] = mandoc_strdup("-T");
-                       argv[argc++] = tag_filename();
+                       argv[argc++] = tag_files->tfn;
                }
        }
+       argv[argc++] = tag_files->ofn;
        argv[argc] = NULL;
 
-       if (pipe(fildes) == -1) {
-               fprintf(stderr, "%s: pipe: %s\n",
-                   progname, strerror(errno));
-               return(0);
-       }
-
        switch (pager_pid = fork()) {
        case -1:
-               fprintf(stderr, "%s: fork: %s\n",
-                   progname, strerror(errno));
-               exit((int)MANDOCLEVEL_SYSERR);
+               err((int)MANDOCLEVEL_SYSERR, "fork");
        case 0:
                break;
        default:
-               close(fildes[0]);
-               if (dup2(fildes[1], STDOUT_FILENO) == -1) {
-                       fprintf(stderr, "%s: dup output: %s\n",
-                           progname, strerror(errno));
-                       exit((int)MANDOCLEVEL_SYSERR);
-               }
-               close(fildes[1]);
-               signal(SIGPIPE, handle_sigpipe);
-               return(pager_pid);
+               return pager_pid;
        }
 
        /* The child 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);
-       }
-       close(fildes[0]);
-
-       /* Hand over to the pager. */
-
+       if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
+               err((int)MANDOCLEVEL_SYSERR, "pager stdout");
+       close(tag_files->ofd);
+       close(tag_files->tfd);
        execvp(argv[0], argv);
-       fprintf(stderr, "%s: exec %s: %s\n",
-           progname, argv[0], strerror(errno));
-       exit((int)MANDOCLEVEL_SYSERR);
+       err((int)MANDOCLEVEL_SYSERR, "exec %s", argv[0]);
 }