[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.80

1.80    ! schwarze    1: /*     $Id: main.c,v 1.79 2011/10/06 23:04:16 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.80    ! schwarze  129:        /*
        !           130:         * Conditionally start up the lookaside buffer before parsing.
        !           131:         */
        !           132:        if (OUTT_MAN == curp.outtype)
        !           133:                mparse_keep(curp.mp);
        !           134:
1.1       kristaps  135:        argc -= optind;
                    136:        argv += optind;
                    137:
1.76      schwarze  138:        rc = MANDOCLEVEL_OK;
1.14      schwarze  139:
1.76      schwarze  140:        if (NULL == *argv)
                    141:                parse(&curp, STDIN_FILENO, "<stdin>", &rc);
1.27      schwarze  142:
                    143:        while (*argv) {
1.76      schwarze  144:                parse(&curp, -1, *argv, &rc);
                    145:                if (MANDOCLEVEL_OK != rc && curp.wstop)
1.27      schwarze  146:                        break;
                    147:                ++argv;
1.1       kristaps  148:        }
                    149:
                    150:        if (curp.outfree)
                    151:                (*curp.outfree)(curp.outdata);
1.76      schwarze  152:        if (curp.mp)
                    153:                mparse_free(curp.mp);
1.1       kristaps  154:
1.76      schwarze  155:        return((int)rc);
1.1       kristaps  156: }
                    157:
1.20      schwarze  158: static void
1.3       schwarze  159: version(void)
                    160: {
                    161:
1.76      schwarze  162:        printf("%s %s\n", progname, VERSION);
1.47      schwarze  163:        exit((int)MANDOCLEVEL_OK);
1.3       schwarze  164: }
                    165:
1.20      schwarze  166: static void
1.1       kristaps  167: usage(void)
                    168: {
                    169:
1.76      schwarze  170:        fprintf(stderr, "usage: %s "
1.59      schwarze  171:                        "[-V] "
                    172:                        "[-foption] "
                    173:                        "[-mformat] "
                    174:                        "[-Ooption] "
                    175:                        "[-Toutput] "
1.76      schwarze  176:                        "[-Wlevel] "
1.59      schwarze  177:                        "[file...]\n",
                    178:                        progname);
                    179:
1.47      schwarze  180:        exit((int)MANDOCLEVEL_BADARG);
1.1       kristaps  181: }
                    182:
1.27      schwarze  183: static void
1.76      schwarze  184: parse(struct curparse *curp, int fd,
                    185:                const char *file, enum mandoclevel *level)
1.52      schwarze  186: {
1.76      schwarze  187:        enum mandoclevel  rc;
                    188:        struct mdoc      *mdoc;
                    189:        struct man       *man;
1.52      schwarze  190:
1.76      schwarze  191:        /* Begin by parsing the file itself. */
1.52      schwarze  192:
1.76      schwarze  193:        assert(file);
                    194:        assert(fd >= -1);
1.52      schwarze  195:
1.76      schwarze  196:        rc = mparse_readfd(curp->mp, fd, file);
1.1       kristaps  197:
1.76      schwarze  198:        /* Stop immediately if the parse has failed. */
1.1       kristaps  199:
1.76      schwarze  200:        if (MANDOCLEVEL_FATAL <= rc)
1.51      schwarze  201:                goto cleanup;
                    202:
                    203:        /*
1.76      schwarze  204:         * With -Wstop and warnings or errors of at least the requested
                    205:         * level, do not produce output.
1.51      schwarze  206:         */
                    207:
1.76      schwarze  208:        if (MANDOCLEVEL_OK != rc && curp->wstop)
1.51      schwarze  209:                goto cleanup;
                    210:
                    211:        /* If unset, allocate output dev now (if applicable). */
                    212:
                    213:        if ( ! (curp->outman && curp->outmdoc)) {
                    214:                switch (curp->outtype) {
                    215:                case (OUTT_XHTML):
                    216:                        curp->outdata = xhtml_alloc(curp->outopts);
1.77      schwarze  217:                        curp->outfree = html_free;
1.51      schwarze  218:                        break;
                    219:                case (OUTT_HTML):
                    220:                        curp->outdata = html_alloc(curp->outopts);
1.77      schwarze  221:                        curp->outfree = html_free;
                    222:                        break;
                    223:                case (OUTT_UTF8):
                    224:                        curp->outdata = utf8_alloc(curp->outopts);
                    225:                        curp->outfree = ascii_free;
                    226:                        break;
                    227:                case (OUTT_LOCALE):
                    228:                        curp->outdata = locale_alloc(curp->outopts);
                    229:                        curp->outfree = ascii_free;
1.51      schwarze  230:                        break;
                    231:                case (OUTT_ASCII):
                    232:                        curp->outdata = ascii_alloc(curp->outopts);
                    233:                        curp->outfree = ascii_free;
                    234:                        break;
                    235:                case (OUTT_PDF):
                    236:                        curp->outdata = pdf_alloc(curp->outopts);
                    237:                        curp->outfree = pspdf_free;
                    238:                        break;
                    239:                case (OUTT_PS):
                    240:                        curp->outdata = ps_alloc(curp->outopts);
                    241:                        curp->outfree = pspdf_free;
                    242:                        break;
                    243:                default:
                    244:                        break;
                    245:                }
                    246:
                    247:                switch (curp->outtype) {
                    248:                case (OUTT_HTML):
                    249:                        /* FALLTHROUGH */
                    250:                case (OUTT_XHTML):
                    251:                        curp->outman = html_man;
                    252:                        curp->outmdoc = html_mdoc;
                    253:                        break;
                    254:                case (OUTT_TREE):
                    255:                        curp->outman = tree_man;
                    256:                        curp->outmdoc = tree_mdoc;
                    257:                        break;
1.78      schwarze  258:                case (OUTT_MAN):
                    259:                        curp->outmdoc = man_mdoc;
1.80    ! schwarze  260:                        curp->outman = man_man;
1.78      schwarze  261:                        break;
1.51      schwarze  262:                case (OUTT_PDF):
                    263:                        /* FALLTHROUGH */
                    264:                case (OUTT_ASCII):
                    265:                        /* FALLTHROUGH */
1.77      schwarze  266:                case (OUTT_UTF8):
                    267:                        /* FALLTHROUGH */
                    268:                case (OUTT_LOCALE):
                    269:                        /* FALLTHROUGH */
1.51      schwarze  270:                case (OUTT_PS):
                    271:                        curp->outman = terminal_man;
                    272:                        curp->outmdoc = terminal_mdoc;
                    273:                        break;
                    274:                default:
                    275:                        break;
                    276:                }
                    277:        }
                    278:
1.76      schwarze  279:        mparse_result(curp->mp, &mdoc, &man);
                    280:
1.51      schwarze  281:        /* Execute the out device, if it exists. */
                    282:
1.76      schwarze  283:        if (man && curp->outman)
                    284:                (*curp->outman)(curp->outdata, man);
                    285:        if (mdoc && curp->outmdoc)
                    286:                (*curp->outmdoc)(curp->outdata, mdoc);
1.51      schwarze  287:
                    288:  cleanup:
1.59      schwarze  289:
1.76      schwarze  290:        mparse_reset(curp->mp);
1.59      schwarze  291:
1.76      schwarze  292:        if (*level < rc)
                    293:                *level = rc;
1.1       kristaps  294: }
                    295:
                    296: static int
1.76      schwarze  297: moptions(enum mparset *tflags, char *arg)
1.1       kristaps  298: {
                    299:
                    300:        if (0 == strcmp(arg, "doc"))
1.76      schwarze  301:                *tflags = MPARSE_MDOC;
1.1       kristaps  302:        else if (0 == strcmp(arg, "andoc"))
1.76      schwarze  303:                *tflags = MPARSE_AUTO;
1.1       kristaps  304:        else if (0 == strcmp(arg, "an"))
1.76      schwarze  305:                *tflags = MPARSE_MAN;
1.1       kristaps  306:        else {
1.20      schwarze  307:                fprintf(stderr, "%s: Bad argument\n", arg);
1.1       kristaps  308:                return(0);
                    309:        }
                    310:
                    311:        return(1);
                    312: }
                    313:
                    314: static int
1.22      schwarze  315: toptions(struct curparse *curp, char *arg)
1.1       kristaps  316: {
                    317:
                    318:        if (0 == strcmp(arg, "ascii"))
1.22      schwarze  319:                curp->outtype = OUTT_ASCII;
                    320:        else if (0 == strcmp(arg, "lint")) {
                    321:                curp->outtype = OUTT_LINT;
1.45      schwarze  322:                curp->wlevel  = MANDOCLEVEL_WARNING;
1.76      schwarze  323:        } else if (0 == strcmp(arg, "tree"))
1.22      schwarze  324:                curp->outtype = OUTT_TREE;
1.78      schwarze  325:        else if (0 == strcmp(arg, "man"))
                    326:                curp->outtype = OUTT_MAN;
1.17      schwarze  327:        else if (0 == strcmp(arg, "html"))
1.22      schwarze  328:                curp->outtype = OUTT_HTML;
1.77      schwarze  329:        else if (0 == strcmp(arg, "utf8"))
                    330:                curp->outtype = OUTT_UTF8;
                    331:        else if (0 == strcmp(arg, "locale"))
                    332:                curp->outtype = OUTT_LOCALE;
1.21      schwarze  333:        else if (0 == strcmp(arg, "xhtml"))
1.22      schwarze  334:                curp->outtype = OUTT_XHTML;
1.36      schwarze  335:        else if (0 == strcmp(arg, "ps"))
                    336:                curp->outtype = OUTT_PS;
1.43      schwarze  337:        else if (0 == strcmp(arg, "pdf"))
                    338:                curp->outtype = OUTT_PDF;
1.1       kristaps  339:        else {
1.20      schwarze  340:                fprintf(stderr, "%s: Bad argument\n", arg);
1.1       kristaps  341:                return(0);
                    342:        }
                    343:
                    344:        return(1);
                    345: }
                    346:
                    347: static int
1.45      schwarze  348: woptions(struct curparse *curp, char *arg)
1.1       kristaps  349: {
1.10      schwarze  350:        char            *v, *o;
1.45      schwarze  351:        const char      *toks[6];
1.1       kristaps  352:
1.45      schwarze  353:        toks[0] = "stop";
                    354:        toks[1] = "all";
                    355:        toks[2] = "warning";
                    356:        toks[3] = "error";
                    357:        toks[4] = "fatal";
                    358:        toks[5] = NULL;
1.1       kristaps  359:
1.10      schwarze  360:        while (*arg) {
                    361:                o = arg;
1.17      schwarze  362:                switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.1       kristaps  363:                case (0):
1.45      schwarze  364:                        curp->wstop = 1;
1.1       kristaps  365:                        break;
                    366:                case (1):
1.45      schwarze  367:                        /* FALLTHROUGH */
1.1       kristaps  368:                case (2):
1.45      schwarze  369:                        curp->wlevel = MANDOCLEVEL_WARNING;
1.1       kristaps  370:                        break;
                    371:                case (3):
1.45      schwarze  372:                        curp->wlevel = MANDOCLEVEL_ERROR;
1.1       kristaps  373:                        break;
                    374:                case (4):
1.45      schwarze  375:                        curp->wlevel = MANDOCLEVEL_FATAL;
1.19      schwarze  376:                        break;
1.1       kristaps  377:                default:
1.45      schwarze  378:                        fprintf(stderr, "-W%s: Bad argument\n", o);
1.1       kristaps  379:                        return(0);
                    380:                }
1.10      schwarze  381:        }
1.1       kristaps  382:
                    383:        return(1);
                    384: }
                    385:
1.75      schwarze  386: static void
1.76      schwarze  387: mmsg(enum mandocerr t, enum mandoclevel lvl,
                    388:                const char *file, int line, int col, const char *msg)
1.30      schwarze  389: {
1.45      schwarze  390:
1.76      schwarze  391:        fprintf(stderr, "%s:%d:%d: %s: %s",
                    392:                        file, line, col + 1,
                    393:                        mparse_strlevel(lvl),
                    394:                        mparse_strerror(t));
1.30      schwarze  395:
                    396:        if (msg)
                    397:                fprintf(stderr, ": %s", msg);
1.76      schwarze  398:
1.30      schwarze  399:        fputc('\n', stderr);
                    400: }