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

Annotation of mandoc/man_validate.c, Revision 1.66

1.66    ! kristaps    1: /*     $Id: man_validate.c,v 1.65 2011/03/20 16:02:05 kristaps Exp $ */
1.1       kristaps    2: /*
1.63      schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
                      4:  * Copyright (c) 2010 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: #ifdef HAVE_CONFIG_H
                     19: #include "config.h"
                     20: #endif
                     21:
1.1       kristaps   22: #include <sys/types.h>
                     23:
                     24: #include <assert.h>
                     25: #include <ctype.h>
1.16      kristaps   26: #include <errno.h>
                     27: #include <limits.h>
1.1       kristaps   28: #include <stdarg.h>
                     29: #include <stdlib.h>
1.46      kristaps   30: #include <string.h>
1.50      kristaps   31: #include <time.h>
1.1       kristaps   32:
1.66    ! kristaps   33: #include "man.h"
1.41      kristaps   34: #include "mandoc.h"
1.1       kristaps   35: #include "libman.h"
1.15      kristaps   36: #include "libmandoc.h"
1.1       kristaps   37:
1.43      kristaps   38: #define        CHKARGS   struct man *m, struct man_node *n
1.1       kristaps   39:
1.17      kristaps   40: typedef        int     (*v_check)(CHKARGS);
1.1       kristaps   41:
                     42: struct man_valid {
1.17      kristaps   43:        v_check  *pres;
                     44:        v_check  *posts;
1.1       kristaps   45: };
                     46:
1.17      kristaps   47: static int       check_bline(CHKARGS);
                     48: static int       check_eq0(CHKARGS);
1.55      kristaps   49: static int       check_ft(CHKARGS);
1.25      kristaps   50: static int       check_le1(CHKARGS);
1.17      kristaps   51: static int       check_ge2(CHKARGS);
                     52: static int       check_le5(CHKARGS);
                     53: static int       check_par(CHKARGS);
1.23      kristaps   54: static int       check_part(CHKARGS);
1.17      kristaps   55: static int       check_root(CHKARGS);
                     56: static int       check_sec(CHKARGS);
                     57: static int       check_text(CHKARGS);
                     58:
1.51      kristaps   59: static int       post_AT(CHKARGS);
                     60: static int       post_fi(CHKARGS);
                     61: static int       post_nf(CHKARGS);
                     62: static int       post_TH(CHKARGS);
                     63: static int       post_UC(CHKARGS);
                     64:
                     65: static v_check   posts_at[] = { post_AT, NULL };
1.17      kristaps   66: static v_check   posts_eq0[] = { check_eq0, NULL };
1.51      kristaps   67: static v_check   posts_fi[] = { check_eq0, post_fi, NULL };
                     68: static v_check   posts_le1[] = { check_le1, NULL };
1.55      kristaps   69: static v_check   posts_ft[] = { check_ft, NULL };
1.51      kristaps   70: static v_check   posts_nf[] = { check_eq0, post_nf, NULL };
1.17      kristaps   71: static v_check   posts_par[] = { check_par, NULL };
1.23      kristaps   72: static v_check   posts_part[] = { check_part, NULL };
1.17      kristaps   73: static v_check   posts_sec[] = { check_sec, NULL };
1.60      schwarze   74: static v_check   posts_th[] = { check_ge2, check_le5, post_TH, NULL };
1.51      kristaps   75: static v_check   posts_uc[] = { post_UC, NULL };
1.17      kristaps   76: static v_check   pres_bline[] = { check_bline, NULL };
1.1       kristaps   77:
1.51      kristaps   78:
1.1       kristaps   79: static const struct man_valid man_valids[MAN_MAX] = {
1.29      kristaps   80:        { NULL, posts_eq0 }, /* br */
1.32      kristaps   81:        { pres_bline, posts_th }, /* TH */
1.17      kristaps   82:        { pres_bline, posts_sec }, /* SH */
                     83:        { pres_bline, posts_sec }, /* SS */
1.59      kristaps   84:        { pres_bline, NULL }, /* TP */
1.17      kristaps   85:        { pres_bline, posts_par }, /* LP */
                     86:        { pres_bline, posts_par }, /* PP */
                     87:        { pres_bline, posts_par }, /* P */
1.59      kristaps   88:        { pres_bline, NULL }, /* IP */
                     89:        { pres_bline, NULL }, /* HP */
1.22      kristaps   90:        { NULL, NULL }, /* SM */
                     91:        { NULL, NULL }, /* SB */
1.17      kristaps   92:        { NULL, NULL }, /* BI */
                     93:        { NULL, NULL }, /* IB */
                     94:        { NULL, NULL }, /* BR */
                     95:        { NULL, NULL }, /* RB */
1.22      kristaps   96:        { NULL, NULL }, /* R */
                     97:        { NULL, NULL }, /* B */
                     98:        { NULL, NULL }, /* I */
1.17      kristaps   99:        { NULL, NULL }, /* IR */
                    100:        { NULL, NULL }, /* RI */
1.47      kristaps  101:        { NULL, posts_eq0 }, /* na */ /* FIXME: should warn only. */
                    102:        { NULL, posts_le1 }, /* sp */ /* FIXME: should warn only. */
1.51      kristaps  103:        { pres_bline, posts_nf }, /* nf */
                    104:        { pres_bline, posts_fi }, /* fi */
1.19      kristaps  105:        { NULL, NULL }, /* RE */
1.23      kristaps  106:        { NULL, posts_part }, /* RS */
1.21      kristaps  107:        { NULL, NULL }, /* DT */
1.51      kristaps  108:        { NULL, posts_uc }, /* UC */
1.26      kristaps  109:        { NULL, NULL }, /* PD */
1.51      kristaps  110:        { NULL, posts_at }, /* AT */
1.47      kristaps  111:        { NULL, NULL }, /* in */
1.55      kristaps  112:        { NULL, posts_ft }, /* ft */
1.1       kristaps  113: };
                    114:
                    115:
                    116: int
1.43      kristaps  117: man_valid_pre(struct man *m, struct man_node *n)
1.17      kristaps  118: {
                    119:        v_check         *cp;
                    120:
1.57      kristaps  121:        switch (n->type) {
                    122:        case (MAN_TEXT):
                    123:                /* FALLTHROUGH */
                    124:        case (MAN_ROOT):
1.61      kristaps  125:                /* FALLTHROUGH */
                    126:        case (MAN_EQN):
1.57      kristaps  127:                /* FALLTHROUGH */
                    128:        case (MAN_TBL):
1.17      kristaps  129:                return(1);
1.57      kristaps  130:        default:
                    131:                break;
                    132:        }
1.17      kristaps  133:
                    134:        if (NULL == (cp = man_valids[n->tok].pres))
                    135:                return(1);
                    136:        for ( ; *cp; cp++)
                    137:                if ( ! (*cp)(m, n))
                    138:                        return(0);
                    139:        return(1);
                    140: }
                    141:
                    142:
                    143: int
1.1       kristaps  144: man_valid_post(struct man *m)
                    145: {
1.17      kristaps  146:        v_check         *cp;
1.1       kristaps  147:
                    148:        if (MAN_VALID & m->last->flags)
                    149:                return(1);
                    150:        m->last->flags |= MAN_VALID;
                    151:
                    152:        switch (m->last->type) {
                    153:        case (MAN_TEXT):
1.11      kristaps  154:                return(check_text(m, m->last));
1.1       kristaps  155:        case (MAN_ROOT):
1.14      kristaps  156:                return(check_root(m, m->last));
1.62      kristaps  157:        case (MAN_EQN):
                    158:                /* FALLTHROUGH */
1.57      kristaps  159:        case (MAN_TBL):
                    160:                return(1);
1.1       kristaps  161:        default:
                    162:                break;
                    163:        }
                    164:
                    165:        if (NULL == (cp = man_valids[m->last->tok].posts))
                    166:                return(1);
                    167:        for ( ; *cp; cp++)
                    168:                if ( ! (*cp)(m, m->last))
                    169:                        return(0);
                    170:
                    171:        return(1);
                    172: }
                    173:
                    174:
1.11      kristaps  175: static int
1.17      kristaps  176: check_root(CHKARGS)
1.14      kristaps  177: {
1.17      kristaps  178:
                    179:        if (MAN_BLINE & m->flags)
1.54      kristaps  180:                man_nmsg(m, n, MANDOCERR_SCOPEEXIT);
                    181:        else if (MAN_ELINE & m->flags)
                    182:                man_nmsg(m, n, MANDOCERR_SCOPEEXIT);
1.22      kristaps  183:
                    184:        m->flags &= ~MAN_BLINE;
                    185:        m->flags &= ~MAN_ELINE;
1.17      kristaps  186:
1.41      kristaps  187:        if (NULL == m->first->child) {
                    188:                man_nmsg(m, n, MANDOCERR_NODOCBODY);
                    189:                return(0);
                    190:        } else if (NULL == m->meta.title) {
1.54      kristaps  191:                man_nmsg(m, n, MANDOCERR_NOTITLE);
                    192:
1.34      kristaps  193:                /*
                    194:                 * If a title hasn't been set, do so now (by
                    195:                 * implication, date and section also aren't set).
                    196:                 */
1.54      kristaps  197:
1.34      kristaps  198:                m->meta.title = mandoc_strdup("unknown");
1.37      kristaps  199:                m->meta.msec = mandoc_strdup("1");
1.65      kristaps  200:                m->meta.date = mandoc_normdate
                    201:                        (m->parse, NULL, n->line, n->pos);
1.34      kristaps  202:        }
1.32      kristaps  203:
                    204:        return(1);
                    205: }
                    206:
                    207:
                    208: static int
1.17      kristaps  209: check_text(CHKARGS)
1.11      kristaps  210: {
1.43      kristaps  211:        char            *p;
1.15      kristaps  212:        int              pos, c;
1.46      kristaps  213:        size_t           sz;
1.11      kristaps  214:
1.46      kristaps  215:        for (p = n->string, pos = n->pos + 1; *p; p++, pos++) {
                    216:                sz = strcspn(p, "\t\\");
                    217:                p += (int)sz;
                    218:
                    219:                if ('\0' == *p)
                    220:                        break;
                    221:
                    222:                pos += (int)sz;
1.11      kristaps  223:
1.46      kristaps  224:                if ('\t' == *p) {
                    225:                        if (MAN_LITERAL & m->flags)
                    226:                                continue;
1.64      kristaps  227:                        man_pmsg(m, n->line, pos, MANDOCERR_BADTAB);
                    228:                        continue;
1.15      kristaps  229:                }
1.45      kristaps  230:
1.46      kristaps  231:                /* Check the special character. */
1.15      kristaps  232:
1.46      kristaps  233:                c = mandoc_special(p);
                    234:                if (c) {
                    235:                        p += c - 1;
                    236:                        pos += c - 1;
1.49      schwarze  237:                } else
                    238:                        man_pmsg(m, n->line, pos, MANDOCERR_BADESCAPE);
1.11      kristaps  239:        }
                    240:
                    241:        return(1);
1.1       kristaps  242: }
                    243:
                    244:
                    245: #define        INEQ_DEFINE(x, ineq, name) \
                    246: static int \
1.17      kristaps  247: check_##name(CHKARGS) \
1.1       kristaps  248: { \
1.11      kristaps  249:        if (n->nchild ineq (x)) \
1.1       kristaps  250:                return(1); \
1.65      kristaps  251:        mandoc_vmsg(MANDOCERR_ARGCOUNT, m->parse, n->line, n->pos, \
1.41      kristaps  252:                        "line arguments %s %d (have %d)", \
                    253:                        #ineq, (x), n->nchild); \
1.60      schwarze  254:        return(1); \
1.1       kristaps  255: }
                    256:
                    257: INEQ_DEFINE(0, ==, eq0)
1.25      kristaps  258: INEQ_DEFINE(1, <=, le1)
1.1       kristaps  259: INEQ_DEFINE(2, >=, ge2)
                    260: INEQ_DEFINE(5, <=, le5)
                    261:
1.55      kristaps  262: static int
                    263: check_ft(CHKARGS)
                    264: {
                    265:        char    *cp;
                    266:        int      ok;
                    267:
                    268:        if (0 == n->nchild)
                    269:                return(1);
                    270:
                    271:        ok = 0;
                    272:        cp = n->child->string;
                    273:        switch (*cp) {
                    274:        case ('1'):
                    275:                /* FALLTHROUGH */
                    276:        case ('2'):
                    277:                /* FALLTHROUGH */
                    278:        case ('3'):
                    279:                /* FALLTHROUGH */
                    280:        case ('4'):
                    281:                /* FALLTHROUGH */
                    282:        case ('I'):
                    283:                /* FALLTHROUGH */
                    284:        case ('P'):
                    285:                /* FALLTHROUGH */
                    286:        case ('R'):
                    287:                if ('\0' == cp[1])
                    288:                        ok = 1;
                    289:                break;
                    290:        case ('B'):
                    291:                if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2]))
                    292:                        ok = 1;
                    293:                break;
                    294:        case ('C'):
                    295:                if ('W' == cp[1] && '\0' == cp[2])
                    296:                        ok = 1;
                    297:                break;
                    298:        default:
                    299:                break;
                    300:        }
                    301:
                    302:        if (0 == ok) {
1.65      kristaps  303:                mandoc_vmsg
                    304:                        (MANDOCERR_BADFONT, m->parse,
                    305:                         n->line, n->pos, "%s", cp);
1.55      kristaps  306:                *cp = '\0';
                    307:        }
                    308:
                    309:        if (1 < n->nchild)
1.65      kristaps  310:                mandoc_vmsg
                    311:                        (MANDOCERR_ARGCOUNT, m->parse, n->line,
                    312:                         n->pos, "want one child (have %d)",
                    313:                         n->nchild);
1.55      kristaps  314:
                    315:        return(1);
                    316: }
1.16      kristaps  317:
                    318: static int
1.17      kristaps  319: check_sec(CHKARGS)
                    320: {
1.16      kristaps  321:
1.41      kristaps  322:        if (MAN_HEAD == n->type && 0 == n->nchild) {
                    323:                man_nmsg(m, n, MANDOCERR_SYNTARGCOUNT);
                    324:                return(0);
                    325:        } else if (MAN_BODY == n->type && 0 == n->nchild)
1.54      kristaps  326:                man_nmsg(m, n, MANDOCERR_NOBODY);
1.41      kristaps  327:
1.16      kristaps  328:        return(1);
                    329: }
1.17      kristaps  330:
                    331:
                    332: static int
1.23      kristaps  333: check_part(CHKARGS)
                    334: {
                    335:
                    336:        if (MAN_BODY == n->type && 0 == n->nchild)
1.54      kristaps  337:                man_nmsg(m, n, MANDOCERR_NOBODY);
                    338:
1.23      kristaps  339:        return(1);
                    340: }
                    341:
                    342:
                    343: static int
1.17      kristaps  344: check_par(CHKARGS)
                    345: {
                    346:
1.59      kristaps  347:        switch (n->type) {
                    348:        case (MAN_BLOCK):
                    349:                if (0 == n->body->nchild)
                    350:                        man_node_delete(m, n);
                    351:                break;
                    352:        case (MAN_BODY):
                    353:                if (0 == n->nchild)
                    354:                        man_nmsg(m, n, MANDOCERR_IGNPAR);
                    355:                break;
                    356:        case (MAN_HEAD):
                    357:                if (n->nchild)
                    358:                        man_nmsg(m, n, MANDOCERR_ARGSLOST);
                    359:                break;
                    360:        default:
                    361:                break;
                    362:        }
1.17      kristaps  363:
                    364:        return(1);
                    365: }
                    366:
                    367:
                    368: static int
                    369: check_bline(CHKARGS)
                    370: {
                    371:
1.22      kristaps  372:        assert( ! (MAN_ELINE & m->flags));
1.41      kristaps  373:        if (MAN_BLINE & m->flags) {
                    374:                man_nmsg(m, n, MANDOCERR_SYNTLINESCOPE);
                    375:                return(0);
                    376:        }
1.31      kristaps  377:
1.18      kristaps  378:        return(1);
1.17      kristaps  379: }
                    380:
1.51      kristaps  381: static int
                    382: post_TH(CHKARGS)
                    383: {
1.60      schwarze  384:        const char      *p;
1.63      schwarze  385:        int              line, pos;
1.51      kristaps  386:
                    387:        if (m->meta.title)
                    388:                free(m->meta.title);
                    389:        if (m->meta.vol)
                    390:                free(m->meta.vol);
                    391:        if (m->meta.source)
                    392:                free(m->meta.source);
                    393:        if (m->meta.msec)
                    394:                free(m->meta.msec);
1.63      schwarze  395:        if (m->meta.date)
                    396:                free(m->meta.date);
1.51      kristaps  397:
1.63      schwarze  398:        line = n->line;
                    399:        pos = n->pos;
                    400:        m->meta.title = m->meta.vol = m->meta.date =
1.51      kristaps  401:                m->meta.msec = m->meta.source = NULL;
                    402:
                    403:        /* ->TITLE<- MSEC DATE SOURCE VOL */
                    404:
                    405:        n = n->child;
1.60      schwarze  406:        if (n && n->string) {
                    407:                for (p = n->string; '\0' != *p; p++) {
                    408:                        /* Only warn about this once... */
                    409:                        if (isalpha((u_char)*p) && ! isupper((u_char)*p)) {
                    410:                                man_nmsg(m, n, MANDOCERR_UPPERCASE);
                    411:                                break;
                    412:                        }
                    413:                }
                    414:                m->meta.title = mandoc_strdup(n->string);
                    415:        } else
                    416:                m->meta.title = mandoc_strdup("");
1.51      kristaps  417:
                    418:        /* TITLE ->MSEC<- DATE SOURCE VOL */
                    419:
1.60      schwarze  420:        if (n)
                    421:                n = n->next;
                    422:        if (n && n->string)
                    423:                m->meta.msec = mandoc_strdup(n->string);
                    424:        else
                    425:                m->meta.msec = mandoc_strdup("");
1.51      kristaps  426:
                    427:        /* TITLE MSEC ->DATE<- SOURCE VOL */
                    428:
1.60      schwarze  429:        if (n)
                    430:                n = n->next;
1.63      schwarze  431:        if (n)
                    432:                pos = n->pos;
1.65      kristaps  433:        m->meta.date = mandoc_normdate
                    434:                (m->parse, n ? n->string : NULL, line, pos);
1.51      kristaps  435:
                    436:        /* TITLE MSEC DATE ->SOURCE<- VOL */
                    437:
                    438:        if (n && (n = n->next))
                    439:                m->meta.source = mandoc_strdup(n->string);
                    440:
                    441:        /* TITLE MSEC DATE SOURCE ->VOL<- */
                    442:
                    443:        if (n && (n = n->next))
                    444:                m->meta.vol = mandoc_strdup(n->string);
                    445:
                    446:        /*
                    447:         * Remove the `TH' node after we've processed it for our
                    448:         * meta-data.
                    449:         */
                    450:        man_node_delete(m, m->last);
                    451:        return(1);
                    452: }
                    453:
                    454: static int
                    455: post_nf(CHKARGS)
                    456: {
                    457:
                    458:        if (MAN_LITERAL & m->flags)
                    459:                man_nmsg(m, n, MANDOCERR_SCOPEREP);
                    460:
                    461:        m->flags |= MAN_LITERAL;
                    462:        return(1);
                    463: }
                    464:
                    465: static int
                    466: post_fi(CHKARGS)
                    467: {
                    468:
                    469:        if ( ! (MAN_LITERAL & m->flags))
1.58      kristaps  470:                man_nmsg(m, n, MANDOCERR_WNOSCOPE);
1.51      kristaps  471:
                    472:        m->flags &= ~MAN_LITERAL;
                    473:        return(1);
                    474: }
                    475:
                    476: static int
                    477: post_UC(CHKARGS)
                    478: {
                    479:        static const char * const bsd_versions[] = {
                    480:            "3rd Berkeley Distribution",
                    481:            "4th Berkeley Distribution",
                    482:            "4.2 Berkeley Distribution",
                    483:            "4.3 Berkeley Distribution",
                    484:            "4.4 Berkeley Distribution",
                    485:        };
                    486:
                    487:        const char      *p, *s;
                    488:
                    489:        n = n->child;
                    490:        n = m->last->child;
                    491:
                    492:        if (NULL == n || MAN_TEXT != n->type)
                    493:                p = bsd_versions[0];
                    494:        else {
                    495:                s = n->string;
                    496:                if (0 == strcmp(s, "3"))
                    497:                        p = bsd_versions[0];
                    498:                else if (0 == strcmp(s, "4"))
                    499:                        p = bsd_versions[1];
                    500:                else if (0 == strcmp(s, "5"))
                    501:                        p = bsd_versions[2];
                    502:                else if (0 == strcmp(s, "6"))
                    503:                        p = bsd_versions[3];
                    504:                else if (0 == strcmp(s, "7"))
                    505:                        p = bsd_versions[4];
                    506:                else
                    507:                        p = bsd_versions[0];
                    508:        }
                    509:
                    510:        if (m->meta.source)
                    511:                free(m->meta.source);
                    512:
                    513:        m->meta.source = mandoc_strdup(p);
                    514:        return(1);
                    515: }
                    516:
                    517: static int
                    518: post_AT(CHKARGS)
                    519: {
                    520:        static const char * const unix_versions[] = {
                    521:            "7th Edition",
                    522:            "System III",
                    523:            "System V",
                    524:            "System V Release 2",
                    525:        };
                    526:
                    527:        const char      *p, *s;
                    528:        struct man_node *nn;
                    529:
                    530:        n = n->child;
                    531:
                    532:        if (NULL == n || MAN_TEXT != n->type)
                    533:                p = unix_versions[0];
                    534:        else {
                    535:                s = n->string;
                    536:                if (0 == strcmp(s, "3"))
                    537:                        p = unix_versions[0];
                    538:                else if (0 == strcmp(s, "4"))
                    539:                        p = unix_versions[1];
                    540:                else if (0 == strcmp(s, "5")) {
                    541:                        nn = n->next;
                    542:                        if (nn && MAN_TEXT == nn->type && nn->string[0])
                    543:                                p = unix_versions[3];
                    544:                        else
                    545:                                p = unix_versions[2];
                    546:                } else
                    547:                        p = unix_versions[0];
                    548:        }
                    549:
                    550:        if (m->meta.source)
                    551:                free(m->meta.source);
                    552:
                    553:        m->meta.source = mandoc_strdup(p);
                    554:        return(1);
                    555: }

CVSweb