]> git.cameronkatri.com Git - mandoc.git/blobdiff - main.c
The upcoming .while request will have to re-execute roff(7) lines
[mandoc.git] / main.c
diff --git a/main.c b/main.c
index 700e3c72dbfae902b15b5e07ee87652a77eea12e..cad227507eaf34302dd3c86e7646d25b69c96097 100644 (file)
--- a/main.c
+++ b/main.c
@@ -1,7 +1,7 @@
-/*     $Id: main.c,v 1.287 2017/03/27 18:51:36 schwarze Exp $ */
+/*     $Id: main.c,v 1.308 2018/08/23 19:33:27 schwarze Exp $ */
 /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010-2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010-2012, 2014-2018 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
@@ -19,7 +19,9 @@
 #include "config.h"
 
 #include <sys/types.h>
+#include <sys/ioctl.h>
 #include <sys/param.h> /* MACHINE */
+#include <sys/termios.h>
 #include <sys/wait.h>
 
 #include <assert.h>
@@ -43,6 +45,7 @@
 
 #include "mandoc_aux.h"
 #include "mandoc.h"
+#include "mandoc_xr.h"
 #include "roff.h"
 #include "mdoc.h"
 #include "man.h"
@@ -56,7 +59,6 @@ enum  outmode {
        OUTMODE_FLN,
        OUTMODE_LST,
        OUTMODE_ALL,
-       OUTMODE_INT,
        OUTMODE_ONE
 };
 
@@ -75,21 +77,24 @@ enum        outt {
 
 struct curparse {
        struct mparse    *mp;
-       enum mandoclevel  wlevel;       /* ignore messages below this */
+       struct manoutput *outopts;      /* output options */
+       void             *outdata;      /* data for output */
+       char             *os_s;         /* operating system for display */
        int               wstop;        /* stop after a file with a warning */
+       enum mandocerr    mmin;         /* ignore messages below this */
+       enum mandoc_os    os_e;         /* check base system conventions */
        enum outt         outtype;      /* which output to use */
-       void             *outdata;      /* data for output */
-       struct manoutput *outopts;      /* output options */
 };
 
 
 int                      mandocdb(int, char *[]);
 
+static void              check_xr(const char *);
 static int               fs_lookup(const struct manpaths *,
                                size_t ipath, const char *,
                                const char *, const char *,
                                struct manpage **, size_t *);
-static void              fs_search(const struct mansearch *,
+static int               fs_search(const struct mansearch *,
                                const struct manpaths *, int, char**,
                                struct manpage **, size_t *);
 static int               koptions(int *, char *);
@@ -108,6 +113,7 @@ 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 enum mandoclevel  rc;
+static FILE             *mmsg_stream;
 
 
 int
@@ -116,16 +122,17 @@ main(int argc, char *argv[])
        struct manconf   conf;
        struct mansearch search;
        struct curparse  curp;
+       struct winsize   ws;
        struct tag_files *tag_files;
        struct manpage  *res, *resp;
        const char      *progname, *sec, *thisarg;
        char            *conf_file, *defpaths, *auxpaths;
-       char            *defos, *oarg;
+       char            *oarg;
        unsigned char   *uc;
        size_t           i, sz;
        int              prio, best_prio;
        enum outmode     outmode;
-       int              fd;
+       int              fd, startdir;
        int              show_usage;
        int              options;
        int              use_pager;
@@ -184,18 +191,22 @@ main(int argc, char *argv[])
 
        memset(&curp, 0, sizeof(struct curparse));
        curp.outtype = OUTT_LOCALE;
-       curp.wlevel  = MANDOCLEVEL_BADARG;
+       curp.mmin = MANDOCERR_MAX;
        curp.outopts = &conf.output;
        options = MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1;
-       defos = NULL;
+       mmsg_stream = stderr;
 
        use_pager = 1;
        tag_files = NULL;
        show_usage = 0;
        outmode = OUTMODE_DEF;
 
-       while (-1 != (c = getopt(argc, argv,
-                       "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
+       while ((c = getopt(argc, argv,
+           "aC:cfhI:iK:klM:m:O:S:s:T:VW:w")) != -1) {
+               if (c == 'i' && search.argmode == ARG_EXPR) {
+                       optind--;
+                       break;
+               }
                switch (c) {
                case 'a':
                        outmode = OUTMODE_ALL;
@@ -219,14 +230,11 @@ main(int argc, char *argv[])
                                warnx("-I %s: Bad argument", optarg);
                                return (int)MANDOCLEVEL_BADARG;
                        }
-                       if (defos) {
+                       if (curp.os_s != NULL) {
                                warnx("-I %s: Duplicate argument", optarg);
                                return (int)MANDOCLEVEL_BADARG;
                        }
-                       defos = mandoc_strdup(optarg + 3);
-                       break;
-               case 'i':
-                       outmode = OUTMODE_INT;
+                       curp.os_s = mandoc_strdup(optarg + 3);
                        break;
                case 'K':
                        if ( ! koptions(&options, optarg))
@@ -311,6 +319,16 @@ main(int argc, char *argv[])
            !isatty(STDOUT_FILENO))
                use_pager = 0;
 
+       if (use_pager &&
+           (conf.output.width == 0 || conf.output.indent == 0) &&
+           ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) != -1 &&
+           ws.ws_col > 1) {
+               if (conf.output.width == 0 && ws.ws_col < 79)
+                       conf.output.width = ws.ws_col - 1;
+               if (conf.output.indent == 0 && ws.ws_col < 66)
+                       conf.output.indent = 3;
+       }
+
 #if HAVE_PLEDGE
        if (!use_pager)
                if (pledge("stdio rpath", NULL) == -1)
@@ -369,15 +387,34 @@ main(int argc, char *argv[])
                    argc, argv, &res, &sz))
                        usage(search.argmode);
 
-               if (sz == 0) {
-                       if (search.argmode == ARG_NAME)
-                               fs_search(&search, &conf.manpath,
-                                   argc, argv, &res, &sz);
-                       else
-                               warnx("nothing appropriate");
+               if (sz == 0 && search.argmode == ARG_NAME)
+                       fs_search(&search, &conf.manpath,
+                           argc, argv, &res, &sz);
+
+               if (search.argmode == ARG_NAME) {
+                       for (c = 0; c < argc; c++) {
+                               if (strchr(argv[c], '/') == NULL)
+                                       continue;
+                               if (access(argv[c], R_OK) == -1) {
+                                       warn("%s", argv[c]);
+                                       continue;
+                               }
+                               res = mandoc_reallocarray(res,
+                                   sz + 1, sizeof(*res));
+                               res[sz].file = mandoc_strdup(argv[c]);
+                               res[sz].names = NULL;
+                               res[sz].output = NULL;
+                               res[sz].ipath = SIZE_MAX;
+                               res[sz].bits = 0;
+                               res[sz].sec = 10;
+                               res[sz].form = FORM_SRC;
+                               sz++;
+                       }
                }
 
                if (sz == 0) {
+                       if (search.argmode != ARG_NAME)
+                               warnx("nothing appropriate");
                        rc = MANDOCLEVEL_BADARG;
                        goto out;
                }
@@ -446,13 +483,8 @@ main(int argc, char *argv[])
                moptions(&options, auxpaths);
 
        mchars_alloc();
-       curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);
-
-       /*
-        * Conditionally start up the lookaside buffer before parsing.
-        */
-       if (OUTT_MAN == curp.outtype)
-               mparse_keep(curp.mp);
+       curp.mp = mparse_alloc(options, curp.mmin, mmsg,
+           curp.os_e, curp.os_s);
 
        if (argc < 1) {
                if (use_pager)
@@ -460,7 +492,29 @@ main(int argc, char *argv[])
                parse(&curp, STDIN_FILENO, "<stdin>");
        }
 
+       /*
+        * Remember the original working directory, if possible.
+        * This will be needed if some names on the command line
+        * are page names and some are relative file names.
+        * Do not error out if the current directory is not
+        * readable: Maybe it won't be needed after all.
+        */
+       startdir = open(".", O_RDONLY | O_DIRECTORY);
+
        while (argc > 0) {
+
+               /*
+                * Changing directories is not needed in ARG_FILE mode.
+                * Do it on a best-effort basis.  Even in case of
+                * failure, some functionality may still work.
+                */
+               if (resp != NULL) {
+                       if (resp->ipath != SIZE_MAX)
+                               (void)chdir(conf.manpath.paths[resp->ipath]);
+                       else if (startdir != -1)
+                               (void)fchdir(startdir);
+               }
+
                fd = mparse_open(curp.mp, resp != NULL ? resp->file : *argv);
                if (fd != -1) {
                        if (use_pager) {
@@ -470,14 +524,23 @@ main(int argc, char *argv[])
 
                        if (resp == NULL)
                                parse(&curp, fd, *argv);
-                       else if (resp->form == FORM_SRC) {
-                               /* For .so only; ignore failure. */
-                               chdir(conf.manpath.paths[resp->ipath]);
+                       else if (resp->form == FORM_SRC)
                                parse(&curp, fd, resp->file);
-                       else
+                       else
                                passthrough(resp->file, fd,
                                    conf.output.synopsisonly);
 
+                       if (ferror(stdout)) {
+                               if (tag_files != NULL) {
+                                       warn("%s", tag_files->ofn);
+                                       tag_unlink();
+                                       tag_files = NULL;
+                               } else
+                                       warn("stdout");
+                               rc = MANDOCLEVEL_SYSERR;
+                               break;
+                       }
+
                        if (argc > 1 && curp.outtype <= OUTT_UTF8) {
                                if (curp.outdata == NULL)
                                        outdata_alloc(&curp);
@@ -496,6 +559,10 @@ main(int argc, char *argv[])
                if (--argc)
                        mparse_reset(curp.mp);
        }
+       if (startdir != -1) {
+               (void)fchdir(startdir);
+               close(startdir);
+       }
 
        if (curp.outdata != NULL) {
                switch (curp.outtype) {
@@ -515,6 +582,7 @@ main(int argc, char *argv[])
                        break;
                }
        }
+       mandoc_xr_free();
        mparse_free(curp.mp);
        mchars_free();
 
@@ -524,7 +592,7 @@ out:
                mansearch_free(res, sz);
        }
 
-       free(defos);
+       free(curp.os_s);
 
        /*
         * When using a pager, finish writing both temporary files,
@@ -658,12 +726,23 @@ fs_lookup(const struct manpaths *paths, size_t ipath,
        if (globres == 0)
                file = mandoc_strdup(*globinfo.gl_pathv);
        globfree(&globinfo);
-       if (globres != 0)
+       if (globres == 0)
+               goto found;
+       if (res != NULL || ipath + 1 != paths->sz)
                return 0;
 
+       mandoc_asprintf(&file, "%s.%s", name, sec);
+       globres = access(file, R_OK);
+       free(file);
+       return globres != -1;
+
 found:
        warnx("outdated mandoc.db lacks %s(%s) entry, run %s %s",
            name, sec, BINM_MAKEWHATIS, paths->paths[ipath]);
+       if (res == NULL) {
+               free(file);
+               return 1;
+       }
        *res = mandoc_reallocarray(*res, ++*ressz, sizeof(struct manpage));
        page = *res + (*ressz - 1);
        page->file = file;
@@ -676,7 +755,7 @@ found:
        return 1;
 }
 
-static void
+static int
 fs_search(const struct mansearch *cfg, const struct manpaths *paths,
        int argc, char **argv, struct manpage **res, size_t *ressz)
 {
@@ -688,7 +767,8 @@ fs_search(const struct mansearch *cfg, const struct manpaths *paths,
 
        assert(cfg->argmode == ARG_NAME);
 
-       *res = NULL;
+       if (res != NULL)
+               *res = NULL;
        *ressz = lastsz = 0;
        while (argc) {
                for (ipath = 0; ipath < paths->sz; ipath++) {
@@ -696,19 +776,27 @@ fs_search(const struct mansearch *cfg, const struct manpaths *paths,
                                if (fs_lookup(paths, ipath, cfg->sec,
                                    cfg->arch, *argv, res, ressz) &&
                                    cfg->firstmatch)
-                                       return;
+                                       return 1;
                        } else for (isec = 0; isec < nsec; isec++)
                                if (fs_lookup(paths, ipath, sections[isec],
                                    cfg->arch, *argv, res, ressz) &&
                                    cfg->firstmatch)
-                                       return;
+                                       return 1;
+               }
+               if (res != NULL && *ressz == lastsz &&
+                   strchr(*argv, '/') == NULL) {
+                       if (cfg->sec == NULL)
+                               warnx("No entry for %s in the manual.",
+                                   *argv);
+                       else
+                               warnx("No entry for %s in section %s "
+                                   "of the manual.", *argv, cfg->sec);
                }
-               if (*ressz == lastsz)
-                       warnx("No entry for %s in the manual.", *argv);
                lastsz = *ressz;
                argv++;
                argc--;
        }
+       return 0;
 }
 
 static void
@@ -745,6 +833,7 @@ parse(struct curparse *curp, int fd, const char *file)
 
        if (man == NULL)
                return;
+       mandoc_xr_reset();
        if (man->macroset == MACROSET_MDOC) {
                if (curp->outtype != OUTT_TREE || !curp->outopts->noval)
                        mdoc_validate(man);
@@ -783,7 +872,7 @@ parse(struct curparse *curp, int fd, const char *file)
                        tree_man(curp->outdata, man);
                        break;
                case OUTT_MAN:
-                       man_man(curp->outdata, man);
+                       mparse_copy(curp->mp);
                        break;
                case OUTT_PDF:
                case OUTT_ASCII:
@@ -796,9 +885,46 @@ parse(struct curparse *curp, int fd, const char *file)
                        break;
                }
        }
+       if (curp->mmin < MANDOCERR_STYLE)
+               check_xr(file);
        mparse_updaterc(curp->mp, &rc);
 }
 
+static void
+check_xr(const char *file)
+{
+       static struct manpaths   paths;
+       struct mansearch         search;
+       struct mandoc_xr        *xr;
+       char                    *cp;
+       size_t                   sz;
+
+       if (paths.sz == 0)
+               manpath_base(&paths);
+
+       for (xr = mandoc_xr_get(); xr != NULL; xr = xr->next) {
+               if (xr->line == -1)
+                       continue;
+               search.arch = NULL;
+               search.sec = xr->sec;
+               search.outkey = NULL;
+               search.argmode = ARG_NAME;
+               search.firstmatch = 1;
+               if (mansearch(&search, &paths, 1, &xr->name, NULL, &sz))
+                       continue;
+               if (fs_search(&search, &paths, 1, &xr->name, NULL, &sz))
+                       continue;
+               if (xr->count == 1)
+                       mandoc_asprintf(&cp, "Xr %s %s", xr->name, xr->sec);
+               else
+                       mandoc_asprintf(&cp, "Xr %s %s (%d times)",
+                           xr->name, xr->sec, xr->count);
+               mmsg(MANDOCERR_XR_BAD, MANDOCLEVEL_STYLE,
+                   file, xr->line, xr->pos + 1, cp);
+               free(cp);
+       }
+}
+
 static void
 outdata_alloc(struct curparse *curp)
 {
@@ -937,7 +1063,8 @@ toptions(struct curparse *curp, char *arg)
                curp->outtype = OUTT_ASCII;
        else if (0 == strcmp(arg, "lint")) {
                curp->outtype = OUTT_LINT;
-               curp->wlevel  = MANDOCLEVEL_WARNING;
+               curp->mmin = MANDOCERR_BASE;
+               mmsg_stream = stdout;
        } else if (0 == strcmp(arg, "tree"))
                curp->outtype = OUTT_TREE;
        else if (0 == strcmp(arg, "man"))
@@ -950,8 +1077,6 @@ toptions(struct curparse *curp, char *arg)
                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"))
@@ -968,15 +1093,19 @@ static int
 woptions(struct curparse *curp, char *arg)
 {
        char            *v, *o;
-       const char      *toks[7];
+       const char      *toks[11];
 
        toks[0] = "stop";
        toks[1] = "all";
-       toks[2] = "warning";
-       toks[3] = "error";
-       toks[4] = "unsupp";
-       toks[5] = "fatal";
-       toks[6] = NULL;
+       toks[2] = "base";
+       toks[3] = "style";
+       toks[4] = "warning";
+       toks[5] = "error";
+       toks[6] = "unsupp";
+       toks[7] = "fatal";
+       toks[8] = "openbsd";
+       toks[9] = "netbsd";
+       toks[10] = NULL;
 
        while (*arg) {
                o = arg;
@@ -986,23 +1115,36 @@ woptions(struct curparse *curp, char *arg)
                        break;
                case 1:
                case 2:
-                       curp->wlevel = MANDOCLEVEL_WARNING;
+                       curp->mmin = MANDOCERR_BASE;
                        break;
                case 3:
-                       curp->wlevel = MANDOCLEVEL_ERROR;
+                       curp->mmin = MANDOCERR_STYLE;
                        break;
                case 4:
-                       curp->wlevel = MANDOCLEVEL_UNSUPP;
+                       curp->mmin = MANDOCERR_WARNING;
                        break;
                case 5:
-                       curp->wlevel = MANDOCLEVEL_BADARG;
+                       curp->mmin = MANDOCERR_ERROR;
+                       break;
+               case 6:
+                       curp->mmin = MANDOCERR_UNSUPP;
+                       break;
+               case 7:
+                       curp->mmin = MANDOCERR_MAX;
+                       break;
+               case 8:
+                       curp->mmin = MANDOCERR_BASE;
+                       curp->os_e = MANDOC_OS_OPENBSD;
+                       break;
+               case 9:
+                       curp->mmin = MANDOCERR_BASE;
+                       curp->os_e = MANDOC_OS_NETBSD;
                        break;
                default:
                        warnx("-W %s: Bad argument", o);
                        return 0;
                }
        }
-
        return 1;
 }
 
@@ -1012,21 +1154,21 @@ mmsg(enum mandocerr t, enum mandoclevel lvl,
 {
        const char      *mparse_msg;
 
-       fprintf(stderr, "%s: %s:", getprogname(),
+       fprintf(mmsg_stream, "%s: %s:", getprogname(),
            file == NULL ? "<stdin>" : file);
 
        if (line)
-               fprintf(stderr, "%d:%d:", line, col + 1);
+               fprintf(mmsg_stream, "%d:%d:", line, col + 1);
 
-       fprintf(stderr, " %s", mparse_strlevel(lvl));
+       fprintf(mmsg_stream, " %s", mparse_strlevel(lvl));
 
-       if (NULL != (mparse_msg = mparse_strerror(t)))
-               fprintf(stderr, ": %s", mparse_msg);
+       if ((mparse_msg = mparse_strerror(t)) != NULL)
+               fprintf(mmsg_stream, ": %s", mparse_msg);
 
        if (msg)
-               fprintf(stderr, ": %s", msg);
+               fprintf(mmsg_stream, ": %s", msg);
 
-       fputc('\n', stderr);
+       fputc('\n', mmsg_stream);
 }
 
 static pid_t
@@ -1099,7 +1241,7 @@ spawn_pager(struct tag_files *tag_files)
        if (dup2(tag_files->ofd, STDOUT_FILENO) == -1)
                err((int)MANDOCLEVEL_SYSERR, "pager stdout");
        close(tag_files->ofd);
-       close(tag_files->tfd);
+       assert(tag_files->tfd == -1);
 
        /* Do not start the pager before controlling the terminal. */