[BACK]Return to main.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / mandoc

Annotation of src/usr.bin/mandoc/main.c, Revision 1.79

1.79    ! schwarze    1: /*     $Id: main.c,v 1.78 2011/09/17 14:45:22 schwarze Exp $ */
1.1       kristaps    2: /*
1.64      schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.70      schwarze    4:  * Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
1.1       kristaps    5:  *
                      6:  * Permission to use, copy, modify, and distribute this software for any
1.2       schwarze    7:  * purpose with or without fee is hereby granted, provided that the above
                      8:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps    9:  *
1.2       schwarze   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     13:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   17:  */
                     18:
                     19: #include <assert.h>
                     20: #include <stdio.h>
1.17      schwarze   21: #include <stdint.h>
1.1       kristaps   22: #include <stdlib.h>
                     23: #include <string.h>
                     24: #include <unistd.h>
                     25:
1.30      schwarze   26: #include "mandoc.h"
1.38      schwarze   27: #include "main.h"
1.1       kristaps   28: #include "mdoc.h"
                     29: #include "man.h"
                     30:
1.16      schwarze   31: typedef        void            (*out_mdoc)(void *, const struct mdoc *);
                     32: typedef        void            (*out_man)(void *, const struct man *);
1.1       kristaps   33: typedef        void            (*out_free)(void *);
                     34:
                     35: enum   outt {
1.76      schwarze   36:        OUTT_ASCII = 0, /* -Tascii */
1.77      schwarze   37:        OUTT_LOCALE,    /* -Tlocale */
                     38:        OUTT_UTF8,      /* -Tutf8 */
1.76      schwarze   39:        OUTT_TREE,      /* -Ttree */
1.78      schwarze   40:        OUTT_MAN,       /* -Tman */
1.76      schwarze   41:        OUTT_HTML,      /* -Thtml */
                     42:        OUTT_XHTML,     /* -Txhtml */
                     43:        OUTT_LINT,      /* -Tlint */
                     44:        OUTT_PS,        /* -Tps */
                     45:        OUTT_PDF        /* -Tpdf */
1.1       kristaps   46: };
                     47:
                     48: struct curparse {
1.76      schwarze   49:        struct mparse    *mp;
1.75      schwarze   50:        enum mandoclevel  wlevel;       /* ignore messages below this */
                     51:        int               wstop;        /* stop after a file with a warning */
1.33      schwarze   52:        enum outt         outtype;      /* which output to use */
                     53:        out_mdoc          outmdoc;      /* mdoc output ptr */
                     54:        out_man           outman;       /* man output ptr */
                     55:        out_free          outfree;      /* free output ptr */
                     56:        void             *outdata;      /* data for output */
                     57:        char              outopts[BUFSIZ]; /* buf of output opts */
                     58: };
                     59:
1.79    ! schwarze   60: int                      apropos(int, char**);
        !            61: int                      mandocdb(int, char**);
        !            62:
1.76      schwarze   63: static int               moptions(enum mparset *, char *);
                     64: static void              mmsg(enum mandocerr, enum mandoclevel,
                     65:                                const char *, int, int, const char *);
                     66: static void              parse(struct curparse *, int,
                     67:                                const char *, enum mandoclevel *);
1.27      schwarze   68: static int               toptions(struct curparse *, char *);
                     69: static void              usage(void) __attribute__((noreturn));
1.20      schwarze   70: static void              version(void) __attribute__((noreturn));
1.45      schwarze   71: static int               woptions(struct curparse *, char *);
1.1       kristaps   72:
1.19      schwarze   73: static const char       *progname;
1.1       kristaps   74:
                     75: int
                     76: main(int argc, char *argv[])
                     77: {
1.27      schwarze   78:        int              c;
1.1       kristaps   79:        struct curparse  curp;
1.76      schwarze   80:        enum mparset     type;
                     81:        enum mandoclevel rc;
1.1       kristaps   82:
1.19      schwarze   83:        progname = strrchr(argv[0], '/');
                     84:        if (progname == NULL)
                     85:                progname = argv[0];
                     86:        else
                     87:                ++progname;
1.79    ! schwarze   88:
        !            89:        if (0 == strncmp(progname, "apropos", 7))
        !            90:                return(apropos(argc, argv));
        !            91:        if (0 == strncmp(progname, "mandocdb", 8))
        !            92:                return(mandocdb(argc, argv));
1.19      schwarze   93:
                     94:        memset(&curp, 0, sizeof(struct curparse));
1.1       kristaps   95:
1.76      schwarze   96:        type = MPARSE_AUTO;
1.1       kristaps   97:        curp.outtype = OUTT_ASCII;
1.45      schwarze   98:        curp.wlevel  = MANDOCLEVEL_FATAL;
1.1       kristaps   99:
                    100:        /* LINTED */
1.45      schwarze  101:        while (-1 != (c = getopt(argc, argv, "m:O:T:VW:")))
1.1       kristaps  102:                switch (c) {
                    103:                case ('m'):
1.76      schwarze  104:                        if ( ! moptions(&type, optarg))
1.47      schwarze  105:                                return((int)MANDOCLEVEL_BADARG);
1.1       kristaps  106:                        break;
1.18      schwarze  107:                case ('O'):
                    108:                        (void)strlcat(curp.outopts, optarg, BUFSIZ);
                    109:                        (void)strlcat(curp.outopts, ",", BUFSIZ);
1.17      schwarze  110:                        break;
1.1       kristaps  111:                case ('T'):
1.22      schwarze  112:                        if ( ! toptions(&curp, optarg))
1.47      schwarze  113:                                return((int)MANDOCLEVEL_BADARG);
1.1       kristaps  114:                        break;
                    115:                case ('W'):
1.45      schwarze  116:                        if ( ! woptions(&curp, optarg))
1.47      schwarze  117:                                return((int)MANDOCLEVEL_BADARG);
1.1       kristaps  118:                        break;
1.3       schwarze  119:                case ('V'):
                    120:                        version();
                    121:                        /* NOTREACHED */
1.1       kristaps  122:                default:
                    123:                        usage();
                    124:                        /* NOTREACHED */
                    125:                }
                    126:
1.76      schwarze  127:        curp.mp = mparse_alloc(type, curp.wlevel, mmsg, &curp);
                    128:
1.1       kristaps  129:        argc -= optind;
                    130:        argv += optind;
                    131:
1.76      schwarze  132:        rc = MANDOCLEVEL_OK;
1.14      schwarze  133:
1.76      schwarze  134:        if (NULL == *argv)
                    135:                parse(&curp, STDIN_FILENO, "<stdin>", &rc);
1.27      schwarze  136:
                    137:        while (*argv) {
1.76      schwarze  138:                parse(&curp, -1, *argv, &rc);
                    139:                if (MANDOCLEVEL_OK != rc && curp.wstop)
1.27      schwarze  140:                        break;
                    141:                ++argv;
1.1       kristaps  142:        }
                    143:
                    144:        if (curp.outfree)
                    145:                (*curp.outfree)(curp.outdata);
1.76      schwarze  146:        if (curp.mp)
                    147:                mparse_free(curp.mp);
1.1       kristaps  148:
1.76      schwarze  149:        return((int)rc);
1.1       kristaps  150: }
                    151:
1.20      schwarze  152: static void
1.3       schwarze  153: version(void)
                    154: {
                    155:
1.76      schwarze  156:        printf("%s %s\n", progname, VERSION);
1.47      schwarze  157:        exit((int)MANDOCLEVEL_OK);
1.3       schwarze  158: }
                    159:
1.20      schwarze  160: static void
1.1       kristaps  161: usage(void)
                    162: {
                    163:
1.76      schwarze  164:        fprintf(stderr, "usage: %s "
1.59      schwarze  165:                        "[-V] "
                    166:                        "[-foption] "
                    167:                        "[-mformat] "
                    168:                        "[-Ooption] "
                    169:                        "[-Toutput] "
1.76      schwarze  170:                        "[-Wlevel] "
1.59      schwarze  171:                        "[file...]\n",
                    172:                        progname);
                    173:
1.47      schwarze  174:        exit((int)MANDOCLEVEL_BADARG);
1.1       kristaps  175: }
                    176:
1.27      schwarze  177: static void
1.76      schwarze  178: parse(struct curparse *curp, int fd,
                    179:                const char *file, enum mandoclevel *level)
1.52      schwarze  180: {
1.76      schwarze  181:        enum mandoclevel  rc;
                    182:        struct mdoc      *mdoc;
                    183:        struct man       *man;
1.52      schwarze  184:
1.76      schwarze  185:        /* Begin by parsing the file itself. */
1.52      schwarze  186:
1.76      schwarze  187:        assert(file);
                    188:        assert(fd >= -1);
1.52      schwarze  189:
1.76      schwarze  190:        rc = mparse_readfd(curp->mp, fd, file);
1.1       kristaps  191:
1.76      schwarze  192:        /* Stop immediately if the parse has failed. */
1.1       kristaps  193:
1.76      schwarze  194:        if (MANDOCLEVEL_FATAL <= rc)
1.51      schwarze  195:                goto cleanup;
                    196:
                    197:        /*
1.76      schwarze  198:         * With -Wstop and warnings or errors of at least the requested
                    199:         * level, do not produce output.
1.51      schwarze  200:         */
                    201:
1.76      schwarze  202:        if (MANDOCLEVEL_OK != rc && curp->wstop)
1.51      schwarze  203:                goto cleanup;
                    204:
                    205:        /* If unset, allocate output dev now (if applicable). */
                    206:
                    207:        if ( ! (curp->outman && curp->outmdoc)) {
                    208:                switch (curp->outtype) {
                    209:                case (OUTT_XHTML):
                    210:                        curp->outdata = xhtml_alloc(curp->outopts);
1.77      schwarze  211:                        curp->outfree = html_free;
1.51      schwarze  212:                        break;
                    213:                case (OUTT_HTML):
                    214:                        curp->outdata = html_alloc(curp->outopts);
1.77      schwarze  215:                        curp->outfree = html_free;
                    216:                        break;
                    217:                case (OUTT_UTF8):
                    218:                        curp->outdata = utf8_alloc(curp->outopts);
                    219:                        curp->outfree = ascii_free;
                    220:                        break;
                    221:                case (OUTT_LOCALE):
                    222:                        curp->outdata = locale_alloc(curp->outopts);
                    223:                        curp->outfree = ascii_free;
1.51      schwarze  224:                        break;
                    225:                case (OUTT_ASCII):
                    226:                        curp->outdata = ascii_alloc(curp->outopts);
                    227:                        curp->outfree = ascii_free;
                    228:                        break;
                    229:                case (OUTT_PDF):
                    230:                        curp->outdata = pdf_alloc(curp->outopts);
                    231:                        curp->outfree = pspdf_free;
                    232:                        break;
                    233:                case (OUTT_PS):
                    234:                        curp->outdata = ps_alloc(curp->outopts);
                    235:                        curp->outfree = pspdf_free;
                    236:                        break;
                    237:                default:
                    238:                        break;
                    239:                }
                    240:
                    241:                switch (curp->outtype) {
                    242:                case (OUTT_HTML):
                    243:                        /* FALLTHROUGH */
                    244:                case (OUTT_XHTML):
                    245:                        curp->outman = html_man;
                    246:                        curp->outmdoc = html_mdoc;
                    247:                        break;
                    248:                case (OUTT_TREE):
                    249:                        curp->outman = tree_man;
                    250:                        curp->outmdoc = tree_mdoc;
                    251:                        break;
1.78      schwarze  252:                case (OUTT_MAN):
                    253:                        curp->outmdoc = man_mdoc;
                    254:                        break;
1.51      schwarze  255:                case (OUTT_PDF):
                    256:                        /* FALLTHROUGH */
                    257:                case (OUTT_ASCII):
                    258:                        /* FALLTHROUGH */
1.77      schwarze  259:                case (OUTT_UTF8):
                    260:                        /* FALLTHROUGH */
                    261:                case (OUTT_LOCALE):
                    262:                        /* FALLTHROUGH */
1.51      schwarze  263:                case (OUTT_PS):
                    264:                        curp->outman = terminal_man;
                    265:                        curp->outmdoc = terminal_mdoc;
                    266:                        break;
                    267:                default:
                    268:                        break;
                    269:                }
                    270:        }
                    271:
1.76      schwarze  272:        mparse_result(curp->mp, &mdoc, &man);
                    273:
1.51      schwarze  274:        /* Execute the out device, if it exists. */
                    275:
1.76      schwarze  276:        if (man && curp->outman)
                    277:                (*curp->outman)(curp->outdata, man);
                    278:        if (mdoc && curp->outmdoc)
                    279:                (*curp->outmdoc)(curp->outdata, mdoc);
1.51      schwarze  280:
                    281:  cleanup:
1.59      schwarze  282:
1.76      schwarze  283:        mparse_reset(curp->mp);
1.59      schwarze  284:
1.76      schwarze  285:        if (*level < rc)
                    286:                *level = rc;
1.1       kristaps  287: }
                    288:
                    289: static int
1.76      schwarze  290: moptions(enum mparset *tflags, char *arg)
1.1       kristaps  291: {
                    292:
                    293:        if (0 == strcmp(arg, "doc"))
1.76      schwarze  294:                *tflags = MPARSE_MDOC;
1.1       kristaps  295:        else if (0 == strcmp(arg, "andoc"))
1.76      schwarze  296:                *tflags = MPARSE_AUTO;
1.1       kristaps  297:        else if (0 == strcmp(arg, "an"))
1.76      schwarze  298:                *tflags = MPARSE_MAN;
1.1       kristaps  299:        else {
1.20      schwarze  300:                fprintf(stderr, "%s: Bad argument\n", arg);
1.1       kristaps  301:                return(0);
                    302:        }
                    303:
                    304:        return(1);
                    305: }
                    306:
                    307: static int
1.22      schwarze  308: toptions(struct curparse *curp, char *arg)
1.1       kristaps  309: {
                    310:
                    311:        if (0 == strcmp(arg, "ascii"))
1.22      schwarze  312:                curp->outtype = OUTT_ASCII;
                    313:        else if (0 == strcmp(arg, "lint")) {
                    314:                curp->outtype = OUTT_LINT;
1.45      schwarze  315:                curp->wlevel  = MANDOCLEVEL_WARNING;
1.76      schwarze  316:        } else if (0 == strcmp(arg, "tree"))
1.22      schwarze  317:                curp->outtype = OUTT_TREE;
1.78      schwarze  318:        else if (0 == strcmp(arg, "man"))
                    319:                curp->outtype = OUTT_MAN;
1.17      schwarze  320:        else if (0 == strcmp(arg, "html"))
1.22      schwarze  321:                curp->outtype = OUTT_HTML;
1.77      schwarze  322:        else if (0 == strcmp(arg, "utf8"))
                    323:                curp->outtype = OUTT_UTF8;
                    324:        else if (0 == strcmp(arg, "locale"))
                    325:                curp->outtype = OUTT_LOCALE;
1.21      schwarze  326:        else if (0 == strcmp(arg, "xhtml"))
1.22      schwarze  327:                curp->outtype = OUTT_XHTML;
1.36      schwarze  328:        else if (0 == strcmp(arg, "ps"))
                    329:                curp->outtype = OUTT_PS;
1.43      schwarze  330:        else if (0 == strcmp(arg, "pdf"))
                    331:                curp->outtype = OUTT_PDF;
1.1       kristaps  332:        else {
1.20      schwarze  333:                fprintf(stderr, "%s: Bad argument\n", arg);
1.1       kristaps  334:                return(0);
                    335:        }
                    336:
                    337:        return(1);
                    338: }
                    339:
                    340: static int
1.45      schwarze  341: woptions(struct curparse *curp, char *arg)
1.1       kristaps  342: {
1.10      schwarze  343:        char            *v, *o;
1.45      schwarze  344:        const char      *toks[6];
1.1       kristaps  345:
1.45      schwarze  346:        toks[0] = "stop";
                    347:        toks[1] = "all";
                    348:        toks[2] = "warning";
                    349:        toks[3] = "error";
                    350:        toks[4] = "fatal";
                    351:        toks[5] = NULL;
1.1       kristaps  352:
1.10      schwarze  353:        while (*arg) {
                    354:                o = arg;
1.17      schwarze  355:                switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.1       kristaps  356:                case (0):
1.45      schwarze  357:                        curp->wstop = 1;
1.1       kristaps  358:                        break;
                    359:                case (1):
1.45      schwarze  360:                        /* FALLTHROUGH */
1.1       kristaps  361:                case (2):
1.45      schwarze  362:                        curp->wlevel = MANDOCLEVEL_WARNING;
1.1       kristaps  363:                        break;
                    364:                case (3):
1.45      schwarze  365:                        curp->wlevel = MANDOCLEVEL_ERROR;
1.1       kristaps  366:                        break;
                    367:                case (4):
1.45      schwarze  368:                        curp->wlevel = MANDOCLEVEL_FATAL;
1.19      schwarze  369:                        break;
1.1       kristaps  370:                default:
1.45      schwarze  371:                        fprintf(stderr, "-W%s: Bad argument\n", o);
1.1       kristaps  372:                        return(0);
                    373:                }
1.10      schwarze  374:        }
1.1       kristaps  375:
                    376:        return(1);
                    377: }
                    378:
1.75      schwarze  379: static void
1.76      schwarze  380: mmsg(enum mandocerr t, enum mandoclevel lvl,
                    381:                const char *file, int line, int col, const char *msg)
1.30      schwarze  382: {
1.45      schwarze  383:
1.76      schwarze  384:        fprintf(stderr, "%s:%d:%d: %s: %s",
                    385:                        file, line, col + 1,
                    386:                        mparse_strlevel(lvl),
                    387:                        mparse_strerror(t));
1.30      schwarze  388:
                    389:        if (msg)
                    390:                fprintf(stderr, ": %s", msg);
1.76      schwarze  391:
1.30      schwarze  392:        fputc('\n', stderr);
                    393: }