]> git.cameronkatri.com Git - mandoc.git/blobdiff - main.c
implement -h (synopsis only) for preformatted (cat) pages;
[mandoc.git] / main.c
diff --git a/main.c b/main.c
index e949afd38523c3309219685199927cb294879885..e56b2dbc3a898bed41d5c7596002479b5d13b31a 100644 (file)
--- a/main.c
+++ b/main.c
@@ -1,4 +1,4 @@
-/*     $Id: main.c,v 1.185 2014/08/22 18:07:15 schwarze Exp $ */
+/*     $Id: main.c,v 1.197 2014/11/11 02:10:04 schwarze Exp $ */
 /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>
@@ -23,6 +23,7 @@
 #include <assert.h>
 #include <ctype.h>
 #include <errno.h>
+#include <fcntl.h>
 #include <stdio.h>
 #include <stdint.h>
 #include <stdlib.h>
@@ -63,7 +64,6 @@ enum  outt {
        OUTT_TREE,      /* -Ttree */
        OUTT_MAN,       /* -Tman */
        OUTT_HTML,      /* -Thtml */
-       OUTT_XHTML,     /* -Txhtml */
        OUTT_LINT,      /* -Tlint */
        OUTT_PS,        /* -Tps */
        OUTT_PDF        /* -Tpdf */
@@ -71,6 +71,7 @@ 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 */
@@ -81,11 +82,13 @@ struct      curparse {
        char              outopts[BUFSIZ]; /* buf of output opts */
 };
 
+static int               koptions(int *, char *);
 static int               moptions(int *, char *);
 static void              mmsg(enum mandocerr, enum mandoclevel,
                                const char *, int, int, const char *);
 static void              parse(struct curparse *, int,
                                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));
@@ -105,16 +108,18 @@ main(int argc, char *argv[])
        char            *conf_file, *defpaths, *auxpaths;
        char            *defos;
 #if HAVE_SQLITE3
-       struct manpage  *res;
-       char            **auxargv;
+       struct manpage  *res, *resp;
        size_t           isec, i, sz;
        int              prio, best_prio;
        char             sec;
 #endif
        enum mandoclevel rc;
        enum outmode     outmode;
+       pid_t            child_pid;
+       int              fd;
        int              show_usage;
        int              use_pager;
+       int              synopsis_only;
        int              options;
        int              c;
 
@@ -146,14 +151,16 @@ main(int argc, char *argv[])
        memset(&curp, 0, sizeof(struct curparse));
        curp.outtype = OUTT_ASCII;
        curp.wlevel  = MANDOCLEVEL_FATAL;
-       options = MPARSE_SO;
+       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:cfI:ikM:m:O:S:s:T:VW:w"))) {
+       while (-1 != (c = getopt(argc, argv,
+                       "aC:cfhI:iK:klM:m:O:S:s:T:VW:w"))) {
                switch (c) {
                case 'a':
                        outmode = OUTMODE_ALL;
@@ -167,6 +174,11 @@ main(int argc, char *argv[])
                case 'f':
                        search.argmode = ARG_WORD;
                        break;
+               case 'h':
+                       (void)strlcat(curp.outopts, "synopsis,", BUFSIZ);
+                       synopsis_only = 1;
+                       outmode = OUTMODE_ALL;
+                       break;
                case 'I':
                        if (strncmp(optarg, "os=", 3)) {
                                fprintf(stderr,
@@ -185,9 +197,17 @@ main(int argc, char *argv[])
                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;
@@ -250,7 +270,7 @@ main(int argc, char *argv[])
        argc -= optind;
        argv += optind;
 #if HAVE_SQLITE3
-       auxargv = NULL;
+       resp = NULL;
 #endif
 
        /* Quirk for a man(1) section argument without -s. */
@@ -279,7 +299,15 @@ main(int argc, char *argv[])
                mansearch_setup(1);
                if( ! mansearch(&search, &paths, argc, argv, &res, &sz))
                        usage(search.argmode);
-               manpath_free(&paths);
+               resp = res;
+
+               if (sz == 0) {
+                       if (search.argmode == ARG_NAME)
+                               fprintf(stderr, "%s: No entry for %s "
+                                   "in the manual.\n", progname, argv[0]);
+                       rc = MANDOCLEVEL_BADARG;
+                       goto out;
+               }
 
                /*
                 * For standard man(1) and -a output mode,
@@ -289,15 +317,9 @@ main(int argc, char *argv[])
 
                if (outmode == OUTMODE_ONE) {
                        argc = 1;
-                       argv[0] = res[0].file;
-                       argv[1] = NULL;
                        best_prio = 10;
-               } else if (outmode == OUTMODE_ALL) {
+               } else if (outmode == OUTMODE_ALL)
                        argc = (int)sz;
-                       argv = auxargv = mandoc_reallocarray(
-                           NULL, sz + 1, sizeof(char *));
-                       argv[argc] = NULL;
-               }
 
                /* Iterate all matching manuals. */
 
@@ -308,9 +330,7 @@ main(int argc, char *argv[])
                                printf("%s - %s\n", res[i].names,
                                    res[i].output == NULL ? "" :
                                    res[i].output);
-                       else if (outmode == OUTMODE_ALL)
-                               argv[i] = res[i].file;
-                       else {
+                       else if (outmode == OUTMODE_ONE) {
                                /* Search for the best section. */
                                isec = strcspn(res[i].file, "123456789");
                                sec = res[i].file[isec];
@@ -320,7 +340,7 @@ main(int argc, char *argv[])
                                if (prio >= best_prio)
                                        continue;
                                best_prio = prio;
-                               argv[0] = res[i].file;
+                               resp = res + i;
                        }
                }
 
@@ -347,7 +367,9 @@ main(int argc, char *argv[])
        if (use_pager && isatty(STDOUT_FILENO))
                spawn_pager();
 
-       curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);
+       curp.mchars = mchars_alloc();
+       curp.mp = mparse_alloc(options, curp.wlevel, mmsg,
+           curp.mchars, defos);
 
        /*
         * Conditionally start up the lookaside buffer before parsing.
@@ -355,27 +377,53 @@ main(int argc, char *argv[])
        if (OUTT_MAN == curp.outtype)
                mparse_keep(curp.mp);
 
-       if (NULL == *argv)
+       if (argc == 0)
                parse(&curp, STDIN_FILENO, "<stdin>", &rc);
 
-       while (*argv) {
-               parse(&curp, -1, *argv, &rc);
+       while (argc) {
+#if HAVE_SQLITE3
+               if (resp != NULL) {
+                       rc = mparse_open(curp.mp, &fd, resp->file,
+                           &child_pid);
+                       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++,
+                           &child_pid);
+                       if (fd != -1)
+                               parse(&curp, fd, argv[-1], &rc);
+               }
+
+               if (child_pid &&
+                   mparse_wait(curp.mp, child_pid) != MANDOCLEVEL_OK)
+                       rc = MANDOCLEVEL_SYSERR;
+
                if (MANDOCLEVEL_OK != rc && curp.wstop)
                        break;
-               ++argv;
+               argc--;
        }
 
        if (curp.outfree)
                (*curp.outfree)(curp.outdata);
-       if (curp.mp)
-               mparse_free(curp.mp);
+       mparse_free(curp.mp);
+       mchars_free(curp.mchars);
 
 #if HAVE_SQLITE3
 out:
        if (search.argmode != ARG_FILE) {
+               manpath_free(&paths);
                mansearch_free(res, sz);
                mansearch_setup(0);
-               free(auxargv);
        }
 #endif
 
@@ -398,22 +446,23 @@ usage(enum argmode argmode)
 
        switch (argmode) {
        case ARG_FILE:
-               fputs("usage: mandoc [-V] [-Ios=name] [-mformat]"
-                   " [-Ooption] [-Toutput] [-Wlevel]\n"
-                   "\t      [file ...]\n", stderr);
+               fputs("usage: mandoc [-acfhklV] [-Ios=name] "
+                   "[-Kencoding] [-mformat] [-Ooption]\n"
+                   "\t      [-Toutput] [-Wlevel] [file ...]\n", stderr);
                break;
        case ARG_NAME:
-               fputs("usage: man [-acfhkVw] [-C file] "
+               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 [-V] [-C file] [-M path] [-m path] "
-                   "[-S arch] [-s section] name ...\n", stderr);
+               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 [-V] [-C file] [-M path] [-m path] "
-                   "[-O outkey] [-S arch]\n"
+               fputs("usage: apropos [-acfhklVw] [-C file] "
+                   "[-M path] [-m path] [-O outkey] [-S arch]\n"
                    "\t       [-s section] expression ...\n", stderr);
                break;
        }
@@ -452,32 +501,34 @@ parse(struct curparse *curp, int fd, const char *file,
 
        if ( ! (curp->outman && curp->outmdoc)) {
                switch (curp->outtype) {
-               case OUTT_XHTML:
-                       curp->outdata = xhtml_alloc(curp->outopts);
-                       curp->outfree = html_free;
-                       break;
                case OUTT_HTML:
-                       curp->outdata = html_alloc(curp->outopts);
+                       curp->outdata = html_alloc(curp->mchars,
+                           curp->outopts);
                        curp->outfree = html_free;
                        break;
                case OUTT_UTF8:
-                       curp->outdata = utf8_alloc(curp->outopts);
+                       curp->outdata = utf8_alloc(curp->mchars,
+                           curp->outopts);
                        curp->outfree = ascii_free;
                        break;
                case OUTT_LOCALE:
-                       curp->outdata = locale_alloc(curp->outopts);
+                       curp->outdata = locale_alloc(curp->mchars,
+                           curp->outopts);
                        curp->outfree = ascii_free;
                        break;
                case OUTT_ASCII:
-                       curp->outdata = ascii_alloc(curp->outopts);
+                       curp->outdata = ascii_alloc(curp->mchars,
+                           curp->outopts);
                        curp->outfree = ascii_free;
                        break;
                case OUTT_PDF:
-                       curp->outdata = pdf_alloc(curp->outopts);
+                       curp->outdata = pdf_alloc(curp->mchars,
+                           curp->outopts);
                        curp->outfree = pspdf_free;
                        break;
                case OUTT_PS:
-                       curp->outdata = ps_alloc(curp->outopts);
+                       curp->outdata = ps_alloc(curp->mchars,
+                           curp->outopts);
                        curp->outfree = pspdf_free;
                        break;
                default:
@@ -486,8 +537,6 @@ parse(struct curparse *curp, int fd, const char *file,
 
                switch (curp->outtype) {
                case OUTT_HTML:
-                       /* FALLTHROUGH */
-               case OUTT_XHTML:
                        curp->outman = html_man;
                        curp->outmdoc = html_mdoc;
                        break;
@@ -533,6 +582,90 @@ parse(struct curparse *curp, int fd, const char *file,
                *level = rc;
 }
 
+static enum mandoclevel
+passthrough(const char *file, int fd, int synopsis_only)
+{
+       const char       synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
+       const char       synr[] = "SYNOPSIS";
+
+       FILE            *stream;
+       const char      *syscall;
+       char            *line;
+       size_t           len, off;
+       ssize_t          nw;
+       int              print;
+
+       if ((stream = fdopen(fd, "r")) == NULL) {
+               close(fd);
+               syscall = "fdopen";
+               goto fail;
+       }
+
+       print = 0;
+       while ((line = fgetln(stream, &len)) != NULL) {
+               if (synopsis_only) {
+                       if (print) {
+                               if ( ! isspace((unsigned char)*line))
+                                       goto done;
+                               while (len &&
+                                   isspace((unsigned char)*line)) {
+                                       line++;
+                                       len--;
+                               }
+                       } else {
+                               if ((len == sizeof(synb) &&
+                                    ! strncmp(line, synb, len - 1)) ||
+                                   (len == sizeof(synr) &&
+                                    ! strncmp(line, synr, len - 1)))
+                                       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 (ferror(stream)) {
+               fclose(stream);
+               syscall = "fgetln";
+               goto fail;
+       }
+
+done:
+       fclose(stream);
+       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(1);
+}
+
 static int
 moptions(int *options, char *arg)
 {
@@ -574,7 +707,7 @@ toptions(struct curparse *curp, char *arg)
        else if (0 == strcmp(arg, "locale"))
                curp->outtype = OUTT_LOCALE;
        else if (0 == strcmp(arg, "xhtml"))
-               curp->outtype = OUTT_XHTML;
+               curp->outtype = OUTT_HTML;
        else if (0 == strcmp(arg, "ps"))
                curp->outtype = OUTT_PS;
        else if (0 == strcmp(arg, "pdf"))