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

Annotation of mandoc/man_validate.c, Revision 1.111

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

CVSweb