implement -h (synopsis only) for preformatted (cat) pages;

[mandoc.git] / main.c

diff --git a/main.c b/main.c
index 620cd6c13a2439bdc7d9e9127111fefd4db49ba6..e56b2dbc3a898bed41d5c7596002479b5d13b31a 100644 (file)
--- a/main.c
+++ b/main.c
@@ -1,4 +1,4 @@
-/*     $Id: main.c,v 1.192 2014/09/03 23:21:47 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>
 /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>


@@ -64,7 +64,6 @@ enum  outt {
        OUTT_TREE,      /* -Ttree */
        OUTT_MAN,       /* -Tman */
        OUTT_HTML,      /* -Thtml */
        OUTT_TREE,      /* -Ttree */
        OUTT_MAN,       /* -Tman */
        OUTT_HTML,      /* -Thtml */

-       OUTT_XHTML,     /* -Txhtml */

        OUTT_LINT,      /* -Tlint */
        OUTT_PS,        /* -Tps */
        OUTT_PDF        /* -Tpdf */
        OUTT_LINT,      /* -Tlint */
        OUTT_PS,        /* -Tps */
        OUTT_PDF        /* -Tpdf */


@@ -72,6 +71,7 @@ enum  outt {
 
 struct curparse {
        struct mparse    *mp;
 
 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 */
        enum mandoclevel  wlevel;       /* ignore messages below this */
        int               wstop;        /* stop after a file with a warning */
        enum outt         outtype;      /* which output to use */


@@ -82,12 +82,13 @@ struct      curparse {
        char              outopts[BUFSIZ]; /* buf of output opts */
 };
 
        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 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);
+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              spawn_pager(void);
 static int               toptions(struct curparse *, char *);
 static void              usage(enum argmode) __attribute__((noreturn));


@@ -118,6 +119,7 @@ main(int argc, char *argv[])
        int              fd;
        int              show_usage;
        int              use_pager;
        int              fd;
        int              show_usage;
        int              use_pager;

+       int              synopsis_only;

        int              options;
        int              c;
 
        int              options;
        int              c;
 


@@ -149,14 +151,16 @@ main(int argc, char *argv[])
        memset(&curp, 0, sizeof(struct curparse));
        curp.outtype = OUTT_ASCII;
        curp.wlevel  = MANDOCLEVEL_FATAL;
        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;
        defos = NULL;
 
        use_pager = 1;
        show_usage = 0;

+       synopsis_only = 0;

        outmode = OUTMODE_DEF;
 
        outmode = OUTMODE_DEF;
 

-       while (-1 != (c = getopt(argc, argv, "aC:cfhI:iklM: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;
                switch (c) {
                case 'a':
                        outmode = OUTMODE_ALL;


@@ -172,6 +176,7 @@ main(int argc, char *argv[])
                        break;
                case 'h':
                        (void)strlcat(curp.outopts, "synopsis,", BUFSIZ);
                        break;
                case 'h':
                        (void)strlcat(curp.outopts, "synopsis,", BUFSIZ);

+                       synopsis_only = 1;

                        outmode = OUTMODE_ALL;
                        break;
                case 'I':
                        outmode = OUTMODE_ALL;
                        break;
                case 'I':


@@ -192,6 +197,10 @@ main(int argc, char *argv[])
                case 'i':
                        outmode = OUTMODE_INT;
                        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 'k':
                        search.argmode = ARG_EXPR;
                        break;


@@ -358,7 +367,9 @@ main(int argc, char *argv[])
        if (use_pager && isatty(STDOUT_FILENO))
                spawn_pager();
 
        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.
 
        /*
         * Conditionally start up the lookaside buffer before parsing.


@@ -381,7 +392,8 @@ main(int argc, char *argv[])
                                chdir(paths.paths[resp->ipath]);
                                parse(&curp, fd, resp->file, &rc);
                        } else
                                chdir(paths.paths[resp->ipath]);
                                parse(&curp, fd, resp->file, &rc);
                        } else

-                               rc = passthrough(resp->file, fd);
+                               rc = passthrough(resp->file, fd,
+                                   synopsis_only);

                        resp++;
                } else
 #endif
                        resp++;
                } else
 #endif


@@ -403,8 +415,8 @@ main(int argc, char *argv[])
 
        if (curp.outfree)
                (*curp.outfree)(curp.outdata);
 
        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 HAVE_SQLITE3
 out:


@@ -435,8 +447,8 @@ usage(enum argmode argmode)
        switch (argmode) {
        case ARG_FILE:
                fputs("usage: mandoc [-acfhklV] [-Ios=name] "
        switch (argmode) {
        case ARG_FILE:
                fputs("usage: mandoc [-acfhklV] [-Ios=name] "

-                   "[-mformat] [-Ooption] [-Toutput] [-Wlevel]\n"
-                   "\t      [file ...]\n", stderr);
+                   "[-Kencoding] [-mformat] [-Ooption]\n"
+                   "\t      [-Toutput] [-Wlevel] [file ...]\n", stderr);

                break;
        case ARG_NAME:
                fputs("usage: man [-acfhklVw] [-C file] "
                break;
        case ARG_NAME:
                fputs("usage: man [-acfhklVw] [-C file] "


@@ -489,32 +501,34 @@ parse(struct curparse *curp, int fd, const char *file,
 
        if ( ! (curp->outman && curp->outmdoc)) {
                switch (curp->outtype) {
 
        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:
                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->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->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->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->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->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:
                        curp->outfree = pspdf_free;
                        break;
                default:


@@ -523,8 +537,6 @@ parse(struct curparse *curp, int fd, const char *file,
 
                switch (curp->outtype) {
                case OUTT_HTML:
 
                switch (curp->outtype) {
                case OUTT_HTML:

-                       /* FALLTHROUGH */
-               case OUTT_XHTML:

                        curp->outman = html_man;
                        curp->outmdoc = html_mdoc;
                        break;
                        curp->outman = html_man;
                        curp->outmdoc = html_mdoc;
                        break;


@@ -571,32 +583,89 @@ parse(struct curparse *curp, int fd, const char *file,
 }
 
 static enum mandoclevel
 }
 
 static enum mandoclevel

-passthrough(const char *file, int fd)
+passthrough(const char *file, int fd, int synopsis_only)

 {
 {

-       char             buf[BUFSIZ];
+       const char       synb[] = "S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS";
+       const char       synr[] = "SYNOPSIS";
+
+       FILE            *stream;

        const char      *syscall;
        const char      *syscall;

-       ssize_t          nr, nw, off;
+       char            *line;
+       size_t           len, off;
+       ssize_t          nw;
+       int              print;

 
 

-       while ((nr = read(fd, buf, BUFSIZ)) != -1 && nr != 0)
-               for (off = 0; off < nr; off += nw)
-                       if ((nw = write(STDOUT_FILENO, buf + off,
-                           (size_t)(nr - off))) == -1 || nw == 0) {
+       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;
                        }
                                syscall = "write";
                                goto fail;
                        }

+       }

 
 

-        if (nr == 0) {
-               close(fd);
-               return(MANDOCLEVEL_OK);
-        }
+       if (ferror(stream)) {
+               fclose(stream);
+               syscall = "fgetln";
+               goto fail;
+       }
+
+done:
+       fclose(stream);
+       return(MANDOCLEVEL_OK);

 
 

-       syscall = "read";

 fail:
        fprintf(stderr, "%s: %s: SYSERR: %s: %s",
            progname, file, syscall, strerror(errno));
        return(MANDOCLEVEL_SYSERR);
 }
 
 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)
 {
 static int
 moptions(int *options, char *arg)
 {


@@ -638,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"))
        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"))
        else if (0 == strcmp(arg, "ps"))
                curp->outtype = OUTT_PS;
        else if (0 == strcmp(arg, "pdf"))