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

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