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

1.77    ! schwarze    1: /*     $Id: main.c,v 1.76 2011/04/24 16:22:02 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 */
                     40:        OUTT_HTML,      /* -Thtml */
                     41:        OUTT_XHTML,     /* -Txhtml */
                     42:        OUTT_LINT,      /* -Tlint */
                     43:        OUTT_PS,        /* -Tps */
                     44:        OUTT_PDF        /* -Tpdf */
1.1       kristaps   45: };
                     46:
                     47: struct curparse {
1.76      schwarze   48:        struct mparse    *mp;
1.75      schwarze   49:        enum mandoclevel  wlevel;       /* ignore messages below this */
                     50:        int               wstop;        /* stop after a file with a warning */
1.33      schwarze   51:        enum outt         outtype;      /* which output to use */
                     52:        out_mdoc          outmdoc;      /* mdoc output ptr */
                     53:        out_man           outman;       /* man output ptr */
                     54:        out_free          outfree;      /* free output ptr */
                     55:        void             *outdata;      /* data for output */
                     56:        char              outopts[BUFSIZ]; /* buf of output opts */
                     57: };
                     58:
1.76      schwarze   59: static int               moptions(enum mparset *, char *);
                     60: static void              mmsg(enum mandocerr, enum mandoclevel,
                     61:                                const char *, int, int, const char *);
                     62: static void              parse(struct curparse *, int,
                     63:                                const char *, enum mandoclevel *);
1.27      schwarze   64: static int               toptions(struct curparse *, char *);
                     65: static void              usage(void) __attribute__((noreturn));
1.20      schwarze   66: static void              version(void) __attribute__((noreturn));
1.45      schwarze   67: static int               woptions(struct curparse *, char *);
1.1       kristaps   68:
1.19      schwarze   69: static const char       *progname;
1.1       kristaps   70:
                     71: int
                     72: main(int argc, char *argv[])
                     73: {
1.27      schwarze   74:        int              c;
1.1       kristaps   75:        struct curparse  curp;
1.76      schwarze   76:        enum mparset     type;
                     77:        enum mandoclevel rc;
1.1       kristaps   78:
1.19      schwarze   79:        progname = strrchr(argv[0], '/');
                     80:        if (progname == NULL)
                     81:                progname = argv[0];
                     82:        else
                     83:                ++progname;
                     84:
                     85:        memset(&curp, 0, sizeof(struct curparse));
1.1       kristaps   86:
1.76      schwarze   87:        type = MPARSE_AUTO;
1.1       kristaps   88:        curp.outtype = OUTT_ASCII;
1.45      schwarze   89:        curp.wlevel  = MANDOCLEVEL_FATAL;
1.1       kristaps   90:
                     91:        /* LINTED */
1.45      schwarze   92:        while (-1 != (c = getopt(argc, argv, "m:O:T:VW:")))
1.1       kristaps   93:                switch (c) {
                     94:                case ('m'):
1.76      schwarze   95:                        if ( ! moptions(&type, optarg))
1.47      schwarze   96:                                return((int)MANDOCLEVEL_BADARG);
1.1       kristaps   97:                        break;
1.18      schwarze   98:                case ('O'):
                     99:                        (void)strlcat(curp.outopts, optarg, BUFSIZ);
                    100:                        (void)strlcat(curp.outopts, ",", BUFSIZ);
1.17      schwarze  101:                        break;
1.1       kristaps  102:                case ('T'):
1.22      schwarze  103:                        if ( ! toptions(&curp, optarg))
1.47      schwarze  104:                                return((int)MANDOCLEVEL_BADARG);
1.1       kristaps  105:                        break;
                    106:                case ('W'):
1.45      schwarze  107:                        if ( ! woptions(&curp, optarg))
1.47      schwarze  108:                                return((int)MANDOCLEVEL_BADARG);
1.1       kristaps  109:                        break;
1.3       schwarze  110:                case ('V'):
                    111:                        version();
                    112:                        /* NOTREACHED */
1.1       kristaps  113:                default:
                    114:                        usage();
                    115:                        /* NOTREACHED */
                    116:                }
                    117:
1.76      schwarze  118:        curp.mp = mparse_alloc(type, curp.wlevel, mmsg, &curp);
                    119:
1.1       kristaps  120:        argc -= optind;
                    121:        argv += optind;
                    122:
1.76      schwarze  123:        rc = MANDOCLEVEL_OK;
1.14      schwarze  124:
1.76      schwarze  125:        if (NULL == *argv)
                    126:                parse(&curp, STDIN_FILENO, "<stdin>", &rc);
1.27      schwarze  127:
                    128:        while (*argv) {
1.76      schwarze  129:                parse(&curp, -1, *argv, &rc);
                    130:                if (MANDOCLEVEL_OK != rc && curp.wstop)
1.27      schwarze  131:                        break;
                    132:                ++argv;
1.1       kristaps  133:        }
                    134:
                    135:        if (curp.outfree)
                    136:                (*curp.outfree)(curp.outdata);
1.76      schwarze  137:        if (curp.mp)
                    138:                mparse_free(curp.mp);
1.1       kristaps  139:
1.76      schwarze  140:        return((int)rc);
1.1       kristaps  141: }
                    142:
1.20      schwarze  143: static void
1.3       schwarze  144: version(void)
                    145: {
                    146:
1.76      schwarze  147:        printf("%s %s\n", progname, VERSION);
1.47      schwarze  148:        exit((int)MANDOCLEVEL_OK);
1.3       schwarze  149: }
                    150:
1.20      schwarze  151: static void
1.1       kristaps  152: usage(void)
                    153: {
                    154:
1.76      schwarze  155:        fprintf(stderr, "usage: %s "
1.59      schwarze  156:                        "[-V] "
                    157:                        "[-foption] "
                    158:                        "[-mformat] "
                    159:                        "[-Ooption] "
                    160:                        "[-Toutput] "
1.76      schwarze  161:                        "[-Wlevel] "
1.59      schwarze  162:                        "[file...]\n",
                    163:                        progname);
                    164:
1.47      schwarze  165:        exit((int)MANDOCLEVEL_BADARG);
1.1       kristaps  166: }
                    167:
1.27      schwarze  168: static void
1.76      schwarze  169: parse(struct curparse *curp, int fd,
                    170:                const char *file, enum mandoclevel *level)
1.52      schwarze  171: {
1.76      schwarze  172:        enum mandoclevel  rc;
                    173:        struct mdoc      *mdoc;
                    174:        struct man       *man;
1.52      schwarze  175:
1.76      schwarze  176:        /* Begin by parsing the file itself. */
1.52      schwarze  177:
1.76      schwarze  178:        assert(file);
                    179:        assert(fd >= -1);
1.52      schwarze  180:
1.76      schwarze  181:        rc = mparse_readfd(curp->mp, fd, file);
1.1       kristaps  182:
1.76      schwarze  183:        /* Stop immediately if the parse has failed. */
1.1       kristaps  184:
1.76      schwarze  185:        if (MANDOCLEVEL_FATAL <= rc)
1.51      schwarze  186:                goto cleanup;
                    187:
                    188:        /*
1.76      schwarze  189:         * With -Wstop and warnings or errors of at least the requested
                    190:         * level, do not produce output.
1.51      schwarze  191:         */
                    192:
1.76      schwarze  193:        if (MANDOCLEVEL_OK != rc && curp->wstop)
1.51      schwarze  194:                goto cleanup;
                    195:
                    196:        /* If unset, allocate output dev now (if applicable). */
                    197:
                    198:        if ( ! (curp->outman && curp->outmdoc)) {
                    199:                switch (curp->outtype) {
                    200:                case (OUTT_XHTML):
                    201:                        curp->outdata = xhtml_alloc(curp->outopts);
1.77    ! schwarze  202:                        curp->outfree = html_free;
1.51      schwarze  203:                        break;
                    204:                case (OUTT_HTML):
                    205:                        curp->outdata = html_alloc(curp->outopts);
1.77    ! schwarze  206:                        curp->outfree = html_free;
        !           207:                        break;
        !           208:                case (OUTT_UTF8):
        !           209:                        curp->outdata = utf8_alloc(curp->outopts);
        !           210:                        curp->outfree = ascii_free;
        !           211:                        break;
        !           212:                case (OUTT_LOCALE):
        !           213:                        curp->outdata = locale_alloc(curp->outopts);
        !           214:                        curp->outfree = ascii_free;
1.51      schwarze  215:                        break;
                    216:                case (OUTT_ASCII):
                    217:                        curp->outdata = ascii_alloc(curp->outopts);
                    218:                        curp->outfree = ascii_free;
                    219:                        break;
                    220:                case (OUTT_PDF):
                    221:                        curp->outdata = pdf_alloc(curp->outopts);
                    222:                        curp->outfree = pspdf_free;
                    223:                        break;
                    224:                case (OUTT_PS):
                    225:                        curp->outdata = ps_alloc(curp->outopts);
                    226:                        curp->outfree = pspdf_free;
                    227:                        break;
                    228:                default:
                    229:                        break;
                    230:                }
                    231:
                    232:                switch (curp->outtype) {
                    233:                case (OUTT_HTML):
                    234:                        /* FALLTHROUGH */
                    235:                case (OUTT_XHTML):
                    236:                        curp->outman = html_man;
                    237:                        curp->outmdoc = html_mdoc;
                    238:                        break;
                    239:                case (OUTT_TREE):
                    240:                        curp->outman = tree_man;
                    241:                        curp->outmdoc = tree_mdoc;
                    242:                        break;
                    243:                case (OUTT_PDF):
                    244:                        /* FALLTHROUGH */
                    245:                case (OUTT_ASCII):
                    246:                        /* FALLTHROUGH */
1.77    ! schwarze  247:                case (OUTT_UTF8):
        !           248:                        /* FALLTHROUGH */
        !           249:                case (OUTT_LOCALE):
        !           250:                        /* FALLTHROUGH */
1.51      schwarze  251:                case (OUTT_PS):
                    252:                        curp->outman = terminal_man;
                    253:                        curp->outmdoc = terminal_mdoc;
                    254:                        break;
                    255:                default:
                    256:                        break;
                    257:                }
                    258:        }
                    259:
1.76      schwarze  260:        mparse_result(curp->mp, &mdoc, &man);
                    261:
1.51      schwarze  262:        /* Execute the out device, if it exists. */
                    263:
1.76      schwarze  264:        if (man && curp->outman)
                    265:                (*curp->outman)(curp->outdata, man);
                    266:        if (mdoc && curp->outmdoc)
                    267:                (*curp->outmdoc)(curp->outdata, mdoc);
1.51      schwarze  268:
                    269:  cleanup:
1.59      schwarze  270:
1.76      schwarze  271:        mparse_reset(curp->mp);
1.59      schwarze  272:
1.76      schwarze  273:        if (*level < rc)
                    274:                *level = rc;
1.1       kristaps  275: }
                    276:
                    277: static int
1.76      schwarze  278: moptions(enum mparset *tflags, char *arg)
1.1       kristaps  279: {
                    280:
                    281:        if (0 == strcmp(arg, "doc"))
1.76      schwarze  282:                *tflags = MPARSE_MDOC;
1.1       kristaps  283:        else if (0 == strcmp(arg, "andoc"))
1.76      schwarze  284:                *tflags = MPARSE_AUTO;
1.1       kristaps  285:        else if (0 == strcmp(arg, "an"))
1.76      schwarze  286:                *tflags = MPARSE_MAN;
1.1       kristaps  287:        else {
1.20      schwarze  288:                fprintf(stderr, "%s: Bad argument\n", arg);
1.1       kristaps  289:                return(0);
                    290:        }
                    291:
                    292:        return(1);
                    293: }
                    294:
                    295: static int
1.22      schwarze  296: toptions(struct curparse *curp, char *arg)
1.1       kristaps  297: {
                    298:
                    299:        if (0 == strcmp(arg, "ascii"))
1.22      schwarze  300:                curp->outtype = OUTT_ASCII;
                    301:        else if (0 == strcmp(arg, "lint")) {
                    302:                curp->outtype = OUTT_LINT;
1.45      schwarze  303:                curp->wlevel  = MANDOCLEVEL_WARNING;
1.76      schwarze  304:        } else if (0 == strcmp(arg, "tree"))
1.22      schwarze  305:                curp->outtype = OUTT_TREE;
1.17      schwarze  306:        else if (0 == strcmp(arg, "html"))
1.22      schwarze  307:                curp->outtype = OUTT_HTML;
1.77    ! schwarze  308:        else if (0 == strcmp(arg, "utf8"))
        !           309:                curp->outtype = OUTT_UTF8;
        !           310:        else if (0 == strcmp(arg, "locale"))
        !           311:                curp->outtype = OUTT_LOCALE;
1.21      schwarze  312:        else if (0 == strcmp(arg, "xhtml"))
1.22      schwarze  313:                curp->outtype = OUTT_XHTML;
1.36      schwarze  314:        else if (0 == strcmp(arg, "ps"))
                    315:                curp->outtype = OUTT_PS;
1.43      schwarze  316:        else if (0 == strcmp(arg, "pdf"))
                    317:                curp->outtype = OUTT_PDF;
1.1       kristaps  318:        else {
1.20      schwarze  319:                fprintf(stderr, "%s: Bad argument\n", arg);
1.1       kristaps  320:                return(0);
                    321:        }
                    322:
                    323:        return(1);
                    324: }
                    325:
                    326: static int
1.45      schwarze  327: woptions(struct curparse *curp, char *arg)
1.1       kristaps  328: {
1.10      schwarze  329:        char            *v, *o;
1.45      schwarze  330:        const char      *toks[6];
1.1       kristaps  331:
1.45      schwarze  332:        toks[0] = "stop";
                    333:        toks[1] = "all";
                    334:        toks[2] = "warning";
                    335:        toks[3] = "error";
                    336:        toks[4] = "fatal";
                    337:        toks[5] = NULL;
1.1       kristaps  338:
1.10      schwarze  339:        while (*arg) {
                    340:                o = arg;
1.17      schwarze  341:                switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.1       kristaps  342:                case (0):
1.45      schwarze  343:                        curp->wstop = 1;
1.1       kristaps  344:                        break;
                    345:                case (1):
1.45      schwarze  346:                        /* FALLTHROUGH */
1.1       kristaps  347:                case (2):
1.45      schwarze  348:                        curp->wlevel = MANDOCLEVEL_WARNING;
1.1       kristaps  349:                        break;
                    350:                case (3):
1.45      schwarze  351:                        curp->wlevel = MANDOCLEVEL_ERROR;
1.1       kristaps  352:                        break;
                    353:                case (4):
1.45      schwarze  354:                        curp->wlevel = MANDOCLEVEL_FATAL;
1.19      schwarze  355:                        break;
1.1       kristaps  356:                default:
1.45      schwarze  357:                        fprintf(stderr, "-W%s: Bad argument\n", o);
1.1       kristaps  358:                        return(0);
                    359:                }
1.10      schwarze  360:        }
1.1       kristaps  361:
                    362:        return(1);
                    363: }
                    364:
1.75      schwarze  365: static void
1.76      schwarze  366: mmsg(enum mandocerr t, enum mandoclevel lvl,
                    367:                const char *file, int line, int col, const char *msg)
1.30      schwarze  368: {
1.45      schwarze  369:
1.76      schwarze  370:        fprintf(stderr, "%s:%d:%d: %s: %s",
                    371:                        file, line, col + 1,
                    372:                        mparse_strlevel(lvl),
                    373:                        mparse_strerror(t));
1.30      schwarze  374:
                    375:        if (msg)
                    376:                fprintf(stderr, ": %s", msg);
1.76      schwarze  377:
1.30      schwarze  378:        fputc('\n', stderr);
                    379: }