[BACK]Return to man_validate.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/man_validate.c, Revision 1.108

1.107     schwarze    1: /*     $OpenBSD$ */
1.1       kristaps    2: /*
1.63      schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.88      schwarze    4:  * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
1.1       kristaps    5:  *
                      6:  * Permission to use, copy, modify, and distribute this software for any
1.8       kristaps    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.8       kristaps   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:  */
1.28      kristaps   18: #include "config.h"
                     19:
1.1       kristaps   20: #include <sys/types.h>
                     21:
                     22: #include <assert.h>
                     23: #include <ctype.h>
1.16      kristaps   24: #include <errno.h>
                     25: #include <limits.h>
1.1       kristaps   26: #include <stdarg.h>
                     27: #include <stdlib.h>
1.46      kristaps   28: #include <string.h>
1.50      kristaps   29: #include <time.h>
1.1       kristaps   30:
1.66      kristaps   31: #include "man.h"
1.41      kristaps   32: #include "mandoc.h"
1.89      schwarze   33: #include "mandoc_aux.h"
1.1       kristaps   34: #include "libman.h"
1.15      kristaps   35: #include "libmandoc.h"
1.1       kristaps   36:
1.85      schwarze   37: #define        CHKARGS   struct man *man, struct man_node *n
1.1       kristaps   38:
1.107     schwarze   39: typedef        void    (*v_check)(CHKARGS);
1.1       kristaps   40:
1.107     schwarze   41: static void      check_eq0(CHKARGS);
                     42: static void      check_eq2(CHKARGS);
                     43: static void      check_le1(CHKARGS);
                     44: static void      check_le5(CHKARGS);
                     45: static void      check_par(CHKARGS);
                     46: static void      check_part(CHKARGS);
                     47: static void      check_root(CHKARGS);
                     48: static void      check_text(CHKARGS);
                     49:
                     50: static void      post_AT(CHKARGS);
                     51: static void      post_IP(CHKARGS);
                     52: static void      post_vs(CHKARGS);
                     53: static void      post_fi(CHKARGS);
                     54: static void      post_ft(CHKARGS);
                     55: static void      post_nf(CHKARGS);
                     56: static void      post_TH(CHKARGS);
                     57: static void      post_UC(CHKARGS);
                     58: static void      post_UR(CHKARGS);
1.51      kristaps   59:
1.104     schwarze   60: static v_check man_valids[MAN_MAX] = {
                     61:        post_vs,    /* br */
                     62:        post_TH,    /* TH */
                     63:        NULL,       /* SH */
                     64:        NULL,       /* SS */
                     65:        NULL,       /* TP */
                     66:        check_par,  /* LP */
                     67:        check_par,  /* PP */
                     68:        check_par,  /* P */
                     69:        post_IP,    /* IP */
                     70:        NULL,       /* HP */
                     71:        NULL,       /* SM */
                     72:        NULL,       /* SB */
                     73:        NULL,       /* BI */
                     74:        NULL,       /* IB */
                     75:        NULL,       /* BR */
                     76:        NULL,       /* RB */
                     77:        NULL,       /* R */
                     78:        NULL,       /* B */
                     79:        NULL,       /* I */
                     80:        NULL,       /* IR */
                     81:        NULL,       /* RI */
                     82:        check_eq0,  /* na */
                     83:        post_vs,    /* sp */
                     84:        post_nf,    /* nf */
                     85:        post_fi,    /* fi */
                     86:        NULL,       /* RE */
                     87:        check_part, /* RS */
                     88:        NULL,       /* DT */
                     89:        post_UC,    /* UC */
                     90:        check_le1,  /* PD */
                     91:        post_AT,    /* AT */
                     92:        NULL,       /* in */
                     93:        post_ft,    /* ft */
                     94:        check_eq2,  /* OP */
                     95:        post_nf,    /* EX */
                     96:        post_fi,    /* EE */
                     97:        post_UR,    /* UR */
                     98:        NULL,       /* UE */
                     99:        NULL,       /* ll */
1.1       kristaps  100: };
                    101:
                    102:
1.107     schwarze  103: void
1.85      schwarze  104: man_valid_post(struct man *man)
1.1       kristaps  105: {
1.104     schwarze  106:        struct man_node *n;
1.17      kristaps  107:        v_check         *cp;
1.1       kristaps  108:
1.104     schwarze  109:        n = man->last;
                    110:        if (n->flags & MAN_VALID)
1.107     schwarze  111:                return;
1.104     schwarze  112:        n->flags |= MAN_VALID;
1.1       kristaps  113:
1.104     schwarze  114:        switch (n->type) {
1.91      schwarze  115:        case MAN_TEXT:
1.107     schwarze  116:                check_text(man, n);
                    117:                break;
1.91      schwarze  118:        case MAN_ROOT:
1.107     schwarze  119:                check_root(man, n);
                    120:                break;
1.91      schwarze  121:        case MAN_EQN:
1.62      kristaps  122:                /* FALLTHROUGH */
1.91      schwarze  123:        case MAN_TBL:
1.107     schwarze  124:                break;
1.1       kristaps  125:        default:
1.104     schwarze  126:                cp = man_valids + n->tok;
1.107     schwarze  127:                if (*cp)
                    128:                        (*cp)(man, n);
                    129:                break;
1.1       kristaps  130:        }
                    131: }
                    132:
1.107     schwarze  133: static void
1.91      schwarze  134: check_root(CHKARGS)
1.14      kristaps  135: {
1.17      kristaps  136:
1.101     schwarze  137:        assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
1.17      kristaps  138:
1.93      schwarze  139:        if (NULL == man->first->child)
1.103     schwarze  140:                mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse,
                    141:                    n->line, n->pos, NULL);
1.93      schwarze  142:        else
                    143:                man->meta.hasbody = 1;
                    144:
                    145:        if (NULL == man->meta.title) {
1.105     schwarze  146:                mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
1.103     schwarze  147:                    n->line, n->pos, NULL);
1.54      kristaps  148:
1.34      kristaps  149:                /*
                    150:                 * If a title hasn't been set, do so now (by
                    151:                 * implication, date and section also aren't set).
                    152:                 */
1.54      kristaps  153:
1.105     schwarze  154:                man->meta.title = mandoc_strdup("");
                    155:                man->meta.msec = mandoc_strdup("");
1.88      schwarze  156:                man->meta.date = man->quick ? mandoc_strdup("") :
                    157:                    mandoc_normdate(man->parse, NULL, n->line, n->pos);
1.34      kristaps  158:        }
1.75      kristaps  159: }
                    160:
1.107     schwarze  161: static void
1.75      kristaps  162: check_text(CHKARGS)
                    163: {
                    164:        char            *cp, *p;
                    165:
1.85      schwarze  166:        if (MAN_LITERAL & man->flags)
1.107     schwarze  167:                return;
1.76      schwarze  168:
                    169:        cp = n->string;
                    170:        for (p = cp; NULL != (p = strchr(p, '\t')); p++)
1.99      schwarze  171:                mandoc_msg(MANDOCERR_FI_TAB, man->parse,
                    172:                    n->line, n->pos + (p - cp), NULL);
1.1       kristaps  173: }
                    174:
                    175: #define        INEQ_DEFINE(x, ineq, name) \
1.107     schwarze  176: static void \
1.17      kristaps  177: check_##name(CHKARGS) \
1.1       kristaps  178: { \
1.11      kristaps  179:        if (n->nchild ineq (x)) \
1.107     schwarze  180:                return; \
1.85      schwarze  181:        mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \
1.91      schwarze  182:            "line arguments %s %d (have %d)", \
                    183:            #ineq, (x), n->nchild); \
1.1       kristaps  184: }
                    185:
                    186: INEQ_DEFINE(0, ==, eq0)
1.80      kristaps  187: INEQ_DEFINE(2, ==, eq2)
1.25      kristaps  188: INEQ_DEFINE(1, <=, le1)
1.1       kristaps  189: INEQ_DEFINE(5, <=, le5)
1.86      schwarze  190:
1.107     schwarze  191: static void
1.104     schwarze  192: post_UR(CHKARGS)
1.86      schwarze  193: {
                    194:
                    195:        if (MAN_HEAD == n->type && 1 != n->nchild)
                    196:                mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line,
                    197:                    n->pos, "line arguments eq 1 (have %d)", n->nchild);
1.107     schwarze  198:        check_part(man, n);
1.86      schwarze  199: }
1.1       kristaps  200:
1.107     schwarze  201: static void
1.73      kristaps  202: post_ft(CHKARGS)
1.55      kristaps  203: {
                    204:        char    *cp;
                    205:        int      ok;
                    206:
                    207:        if (0 == n->nchild)
1.107     schwarze  208:                return;
1.55      kristaps  209:
                    210:        ok = 0;
                    211:        cp = n->child->string;
                    212:        switch (*cp) {
1.91      schwarze  213:        case '1':
1.55      kristaps  214:                /* FALLTHROUGH */
1.91      schwarze  215:        case '2':
1.55      kristaps  216:                /* FALLTHROUGH */
1.91      schwarze  217:        case '3':
1.55      kristaps  218:                /* FALLTHROUGH */
1.91      schwarze  219:        case '4':
1.55      kristaps  220:                /* FALLTHROUGH */
1.91      schwarze  221:        case 'I':
1.55      kristaps  222:                /* FALLTHROUGH */
1.91      schwarze  223:        case 'P':
1.55      kristaps  224:                /* FALLTHROUGH */
1.91      schwarze  225:        case 'R':
1.55      kristaps  226:                if ('\0' == cp[1])
                    227:                        ok = 1;
                    228:                break;
1.91      schwarze  229:        case 'B':
1.55      kristaps  230:                if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2]))
                    231:                        ok = 1;
                    232:                break;
1.91      schwarze  233:        case 'C':
1.55      kristaps  234:                if ('W' == cp[1] && '\0' == cp[2])
                    235:                        ok = 1;
                    236:                break;
                    237:        default:
                    238:                break;
                    239:        }
                    240:
                    241:        if (0 == ok) {
1.98      schwarze  242:                mandoc_vmsg(MANDOCERR_FT_BAD, man->parse,
                    243:                    n->line, n->pos, "ft %s", cp);
1.55      kristaps  244:                *cp = '\0';
                    245:        }
                    246:
                    247:        if (1 < n->nchild)
1.91      schwarze  248:                mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line,
                    249:                    n->pos, "want one child (have %d)", n->nchild);
1.55      kristaps  250: }
1.16      kristaps  251:
1.107     schwarze  252: static void
1.23      kristaps  253: check_part(CHKARGS)
                    254: {
                    255:
                    256:        if (MAN_BODY == n->type && 0 == n->nchild)
1.91      schwarze  257:                mandoc_msg(MANDOCERR_ARGCWARN, man->parse, n->line,
                    258:                    n->pos, "want children (have none)");
1.23      kristaps  259: }
                    260:
1.107     schwarze  261: static void
1.17      kristaps  262: check_par(CHKARGS)
                    263: {
                    264:
1.59      kristaps  265:        switch (n->type) {
1.91      schwarze  266:        case MAN_BLOCK:
1.59      kristaps  267:                if (0 == n->body->nchild)
1.85      schwarze  268:                        man_node_delete(man, n);
1.59      kristaps  269:                break;
1.91      schwarze  270:        case MAN_BODY:
1.59      kristaps  271:                if (0 == n->nchild)
1.95      schwarze  272:                        mandoc_vmsg(MANDOCERR_PAR_SKIP,
                    273:                            man->parse, n->line, n->pos,
                    274:                            "%s empty", man_macronames[n->tok]);
1.59      kristaps  275:                break;
1.91      schwarze  276:        case MAN_HEAD:
1.59      kristaps  277:                if (n->nchild)
1.97      schwarze  278:                        mandoc_vmsg(MANDOCERR_ARG_SKIP,
                    279:                            man->parse, n->line, n->pos,
                    280:                            "%s %s%s", man_macronames[n->tok],
                    281:                            n->child->string,
                    282:                            n->nchild > 1 ? " ..." : "");
1.59      kristaps  283:                break;
                    284:        default:
                    285:                break;
                    286:        }
1.17      kristaps  287: }
                    288:
1.107     schwarze  289: static void
1.83      schwarze  290: post_IP(CHKARGS)
                    291: {
                    292:
                    293:        switch (n->type) {
1.91      schwarze  294:        case MAN_BLOCK:
1.83      schwarze  295:                if (0 == n->head->nchild && 0 == n->body->nchild)
1.85      schwarze  296:                        man_node_delete(man, n);
1.83      schwarze  297:                break;
1.91      schwarze  298:        case MAN_BODY:
1.83      schwarze  299:                if (0 == n->parent->head->nchild && 0 == n->nchild)
1.95      schwarze  300:                        mandoc_vmsg(MANDOCERR_PAR_SKIP,
                    301:                            man->parse, n->line, n->pos,
                    302:                            "%s empty", man_macronames[n->tok]);
1.83      schwarze  303:                break;
                    304:        default:
                    305:                break;
                    306:        }
                    307: }
1.17      kristaps  308:
1.107     schwarze  309: static void
1.51      kristaps  310: post_TH(CHKARGS)
                    311: {
1.92      schwarze  312:        struct man_node *nb;
1.60      schwarze  313:        const char      *p;
1.51      kristaps  314:
1.104     schwarze  315:        check_le5(man, n);
                    316:
1.85      schwarze  317:        free(man->meta.title);
                    318:        free(man->meta.vol);
                    319:        free(man->meta.source);
                    320:        free(man->meta.msec);
                    321:        free(man->meta.date);
1.51      kristaps  322:
1.85      schwarze  323:        man->meta.title = man->meta.vol = man->meta.date =
1.91      schwarze  324:            man->meta.msec = man->meta.source = NULL;
1.51      kristaps  325:
1.92      schwarze  326:        nb = n;
                    327:
1.51      kristaps  328:        /* ->TITLE<- MSEC DATE SOURCE VOL */
                    329:
                    330:        n = n->child;
1.60      schwarze  331:        if (n && n->string) {
                    332:                for (p = n->string; '\0' != *p; p++) {
                    333:                        /* Only warn about this once... */
1.91      schwarze  334:                        if (isalpha((unsigned char)*p) &&
                    335:                            ! isupper((unsigned char)*p)) {
1.102     schwarze  336:                                mandoc_vmsg(MANDOCERR_TITLE_CASE,
1.94      schwarze  337:                                    man->parse, n->line,
                    338:                                    n->pos + (p - n->string),
1.102     schwarze  339:                                    "TH %s", n->string);
1.60      schwarze  340:                                break;
                    341:                        }
                    342:                }
1.85      schwarze  343:                man->meta.title = mandoc_strdup(n->string);
1.105     schwarze  344:        } else {
1.85      schwarze  345:                man->meta.title = mandoc_strdup("");
1.105     schwarze  346:                mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
                    347:                    nb->line, nb->pos, "TH");
                    348:        }
1.51      kristaps  349:
                    350:        /* TITLE ->MSEC<- DATE SOURCE VOL */
                    351:
1.60      schwarze  352:        if (n)
                    353:                n = n->next;
                    354:        if (n && n->string)
1.85      schwarze  355:                man->meta.msec = mandoc_strdup(n->string);
1.105     schwarze  356:        else {
1.85      schwarze  357:                man->meta.msec = mandoc_strdup("");
1.105     schwarze  358:                mandoc_vmsg(MANDOCERR_MSEC_MISSING, man->parse,
                    359:                    nb->line, nb->pos, "TH %s", man->meta.title);
                    360:        }
1.51      kristaps  361:
                    362:        /* TITLE MSEC ->DATE<- SOURCE VOL */
                    363:
1.60      schwarze  364:        if (n)
                    365:                n = n->next;
1.77      schwarze  366:        if (n && n->string && '\0' != n->string[0]) {
1.88      schwarze  367:                man->meta.date = man->quick ?
                    368:                    mandoc_strdup(n->string) :
                    369:                    mandoc_normdate(man->parse, n->string,
                    370:                        n->line, n->pos);
1.92      schwarze  371:        } else {
1.85      schwarze  372:                man->meta.date = mandoc_strdup("");
1.102     schwarze  373:                mandoc_msg(MANDOCERR_DATE_MISSING, man->parse,
                    374:                    n ? n->line : nb->line,
                    375:                    n ? n->pos : nb->pos, "TH");
1.92      schwarze  376:        }
1.51      kristaps  377:
                    378:        /* TITLE MSEC DATE ->SOURCE<- VOL */
                    379:
                    380:        if (n && (n = n->next))
1.85      schwarze  381:                man->meta.source = mandoc_strdup(n->string);
1.108   ! schwarze  382:        else if (man->defos != NULL)
        !           383:                man->meta.source = mandoc_strdup(man->defos);
1.51      kristaps  384:
                    385:        /* TITLE MSEC DATE SOURCE ->VOL<- */
1.79      schwarze  386:        /* If missing, use the default VOL name for MSEC. */
1.51      kristaps  387:
                    388:        if (n && (n = n->next))
1.85      schwarze  389:                man->meta.vol = mandoc_strdup(n->string);
                    390:        else if ('\0' != man->meta.msec[0] &&
                    391:            (NULL != (p = mandoc_a2msec(man->meta.msec))))
                    392:                man->meta.vol = mandoc_strdup(p);
1.51      kristaps  393:
                    394:        /*
                    395:         * Remove the `TH' node after we've processed it for our
                    396:         * meta-data.
                    397:         */
1.85      schwarze  398:        man_node_delete(man, man->last);
1.51      kristaps  399: }
                    400:
1.107     schwarze  401: static void
1.51      kristaps  402: post_nf(CHKARGS)
                    403: {
                    404:
1.104     schwarze  405:        check_eq0(man, n);
                    406:
1.85      schwarze  407:        if (MAN_LITERAL & man->flags)
1.102     schwarze  408:                mandoc_msg(MANDOCERR_NF_SKIP, man->parse,
                    409:                    n->line, n->pos, "nf");
1.51      kristaps  410:
1.85      schwarze  411:        man->flags |= MAN_LITERAL;
1.51      kristaps  412: }
                    413:
1.107     schwarze  414: static void
1.51      kristaps  415: post_fi(CHKARGS)
                    416: {
                    417:
1.104     schwarze  418:        check_eq0(man, n);
                    419:
1.85      schwarze  420:        if ( ! (MAN_LITERAL & man->flags))
1.102     schwarze  421:                mandoc_msg(MANDOCERR_FI_SKIP, man->parse,
                    422:                    n->line, n->pos, "fi");
1.51      kristaps  423:
1.85      schwarze  424:        man->flags &= ~MAN_LITERAL;
1.51      kristaps  425: }
                    426:
1.107     schwarze  427: static void
1.51      kristaps  428: post_UC(CHKARGS)
                    429: {
                    430:        static const char * const bsd_versions[] = {
                    431:            "3rd Berkeley Distribution",
                    432:            "4th Berkeley Distribution",
                    433:            "4.2 Berkeley Distribution",
                    434:            "4.3 Berkeley Distribution",
                    435:            "4.4 Berkeley Distribution",
                    436:        };
                    437:
                    438:        const char      *p, *s;
                    439:
                    440:        n = n->child;
                    441:
                    442:        if (NULL == n || MAN_TEXT != n->type)
                    443:                p = bsd_versions[0];
                    444:        else {
                    445:                s = n->string;
                    446:                if (0 == strcmp(s, "3"))
                    447:                        p = bsd_versions[0];
                    448:                else if (0 == strcmp(s, "4"))
                    449:                        p = bsd_versions[1];
                    450:                else if (0 == strcmp(s, "5"))
                    451:                        p = bsd_versions[2];
                    452:                else if (0 == strcmp(s, "6"))
                    453:                        p = bsd_versions[3];
                    454:                else if (0 == strcmp(s, "7"))
                    455:                        p = bsd_versions[4];
                    456:                else
                    457:                        p = bsd_versions[0];
                    458:        }
                    459:
1.85      schwarze  460:        free(man->meta.source);
                    461:        man->meta.source = mandoc_strdup(p);
1.51      kristaps  462: }
                    463:
1.107     schwarze  464: static void
1.51      kristaps  465: post_AT(CHKARGS)
                    466: {
                    467:        static const char * const unix_versions[] = {
                    468:            "7th Edition",
                    469:            "System III",
                    470:            "System V",
                    471:            "System V Release 2",
                    472:        };
                    473:
                    474:        const char      *p, *s;
                    475:        struct man_node *nn;
                    476:
                    477:        n = n->child;
                    478:
                    479:        if (NULL == n || MAN_TEXT != n->type)
                    480:                p = unix_versions[0];
                    481:        else {
                    482:                s = n->string;
                    483:                if (0 == strcmp(s, "3"))
                    484:                        p = unix_versions[0];
                    485:                else if (0 == strcmp(s, "4"))
                    486:                        p = unix_versions[1];
                    487:                else if (0 == strcmp(s, "5")) {
                    488:                        nn = n->next;
                    489:                        if (nn && MAN_TEXT == nn->type && nn->string[0])
                    490:                                p = unix_versions[3];
                    491:                        else
                    492:                                p = unix_versions[2];
                    493:                } else
                    494:                        p = unix_versions[0];
                    495:        }
                    496:
1.85      schwarze  497:        free(man->meta.source);
                    498:        man->meta.source = mandoc_strdup(p);
1.70      kristaps  499: }
                    500:
1.107     schwarze  501: static void
1.70      kristaps  502: post_vs(CHKARGS)
                    503: {
1.104     schwarze  504:
                    505:        if (n->tok == MAN_br)
                    506:                check_eq0(man, n);
                    507:        else
                    508:                check_le1(man, n);
1.70      kristaps  509:
1.82      schwarze  510:        if (NULL != n->prev)
1.107     schwarze  511:                return;
1.82      schwarze  512:
                    513:        switch (n->parent->tok) {
1.91      schwarze  514:        case MAN_SH:
1.82      schwarze  515:                /* FALLTHROUGH */
1.91      schwarze  516:        case MAN_SS:
1.95      schwarze  517:                mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,
                    518:                    "%s after %s", man_macronames[n->tok],
                    519:                    man_macronames[n->parent->tok]);
1.82      schwarze  520:                /* FALLTHROUGH */
1.91      schwarze  521:        case MAN_MAX:
                    522:                /*
1.82      schwarze  523:                 * Don't warn about this because it occurs in pod2man
                    524:                 * and would cause considerable (unfixable) warnage.
                    525:                 */
1.85      schwarze  526:                man_node_delete(man, n);
1.82      schwarze  527:                break;
                    528:        default:
                    529:                break;
                    530:        }
1.51      kristaps  531: }

CVSweb