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

Annotation of mandoc/man_validate.c, Revision 1.135

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.134     schwarze    4:  * Copyright (c) 2010, 2012-2018 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.114     schwarze   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.8       kristaps   11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.114     schwarze   12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.8       kristaps   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.114     schwarze   31: #include "mandoc_aux.h"
                     32: #include "mandoc.h"
                     33: #include "roff.h"
1.66      kristaps   34: #include "man.h"
1.114     schwarze   35: #include "libmandoc.h"
1.118     schwarze   36: #include "roff_int.h"
1.1       kristaps   37: #include "libman.h"
                     38:
1.117     schwarze   39: #define        CHKARGS   struct roff_man *man, struct roff_node *n
1.1       kristaps   40:
1.107     schwarze   41: typedef        void    (*v_check)(CHKARGS);
1.1       kristaps   42:
1.107     schwarze   43: static void      check_par(CHKARGS);
                     44: static void      check_part(CHKARGS);
                     45: static void      check_root(CHKARGS);
                     46: static void      check_text(CHKARGS);
                     47:
                     48: static void      post_AT(CHKARGS);
                     49: static void      post_IP(CHKARGS);
1.113     schwarze   50: static void      post_OP(CHKARGS);
1.107     schwarze   51: static void      post_TH(CHKARGS);
                     52: static void      post_UC(CHKARGS);
                     53: static void      post_UR(CHKARGS);
1.129     schwarze   54: static void      post_in(CHKARGS);
                     55: static void      post_vs(CHKARGS);
1.51      kristaps   56:
1.135   ! schwarze   57: static const v_check man_valids[MAN_MAX - MAN_TH] = {
1.104     schwarze   58:        post_TH,    /* TH */
                     59:        NULL,       /* SH */
                     60:        NULL,       /* SS */
                     61:        NULL,       /* TP */
                     62:        check_par,  /* LP */
                     63:        check_par,  /* PP */
                     64:        check_par,  /* P */
                     65:        post_IP,    /* IP */
                     66:        NULL,       /* HP */
                     67:        NULL,       /* SM */
                     68:        NULL,       /* SB */
                     69:        NULL,       /* BI */
                     70:        NULL,       /* IB */
                     71:        NULL,       /* BR */
                     72:        NULL,       /* RB */
                     73:        NULL,       /* R */
                     74:        NULL,       /* B */
                     75:        NULL,       /* I */
                     76:        NULL,       /* IR */
                     77:        NULL,       /* RI */
1.121     schwarze   78:        NULL,       /* nf */
                     79:        NULL,       /* fi */
1.104     schwarze   80:        NULL,       /* RE */
                     81:        check_part, /* RS */
                     82:        NULL,       /* DT */
                     83:        post_UC,    /* UC */
1.112     schwarze   84:        NULL,       /* PD */
1.104     schwarze   85:        post_AT,    /* AT */
1.129     schwarze   86:        post_in,    /* in */
1.113     schwarze   87:        post_OP,    /* OP */
1.121     schwarze   88:        NULL,       /* EX */
                     89:        NULL,       /* EE */
1.104     schwarze   90:        post_UR,    /* UR */
                     91:        NULL,       /* UE */
1.132     schwarze   92:        post_UR,    /* MT */
                     93:        NULL,       /* ME */
1.1       kristaps   94: };
                     95:
                     96:
1.107     schwarze   97: void
1.121     schwarze   98: man_node_validate(struct roff_man *man)
1.1       kristaps   99: {
1.115     schwarze  100:        struct roff_node *n;
1.123     schwarze  101:        const v_check    *cp;
1.1       kristaps  102:
1.104     schwarze  103:        n = man->last;
1.121     schwarze  104:        man->last = man->last->child;
                    105:        while (man->last != NULL) {
                    106:                man_node_validate(man);
                    107:                if (man->last == n)
                    108:                        man->last = man->last->child;
                    109:                else
                    110:                        man->last = man->last->next;
                    111:        }
1.1       kristaps  112:
1.121     schwarze  113:        man->last = n;
                    114:        man->next = ROFF_NEXT_SIBLING;
1.104     schwarze  115:        switch (n->type) {
1.114     schwarze  116:        case ROFFT_TEXT:
1.107     schwarze  117:                check_text(man, n);
                    118:                break;
1.114     schwarze  119:        case ROFFT_ROOT:
1.107     schwarze  120:                check_root(man, n);
                    121:                break;
1.134     schwarze  122:        case ROFFT_COMMENT:
1.114     schwarze  123:        case ROFFT_EQN:
                    124:        case ROFFT_TBL:
1.107     schwarze  125:                break;
1.1       kristaps  126:        default:
1.124     schwarze  127:                if (n->tok < ROFF_MAX) {
                    128:                        switch (n->tok) {
                    129:                        case ROFF_br:
1.127     schwarze  130:                        case ROFF_sp:
1.124     schwarze  131:                                post_vs(man, n);
                    132:                                break;
                    133:                        default:
1.125     schwarze  134:                                roff_validate(man);
                    135:                                break;
1.124     schwarze  136:                        }
                    137:                        break;
                    138:                }
                    139:                assert(n->tok >= MAN_TH && n->tok < MAN_MAX);
1.135   ! schwarze  140:                cp = man_valids + (n->tok - MAN_TH);
1.107     schwarze  141:                if (*cp)
                    142:                        (*cp)(man, n);
1.121     schwarze  143:                if (man->last == n)
                    144:                        man_state(man, n);
1.107     schwarze  145:                break;
1.1       kristaps  146:        }
                    147: }
                    148:
1.107     schwarze  149: static void
1.91      schwarze  150: check_root(CHKARGS)
1.14      kristaps  151: {
1.101     schwarze  152:        assert((man->flags & (MAN_BLINE | MAN_ELINE)) == 0);
1.17      kristaps  153:
1.134     schwarze  154:        if (n->last == NULL || n->last->type == ROFFT_COMMENT)
1.103     schwarze  155:                mandoc_msg(MANDOCERR_DOC_EMPTY, man->parse,
                    156:                    n->line, n->pos, NULL);
1.93      schwarze  157:        else
                    158:                man->meta.hasbody = 1;
                    159:
                    160:        if (NULL == man->meta.title) {
1.105     schwarze  161:                mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
1.103     schwarze  162:                    n->line, n->pos, NULL);
1.54      kristaps  163:
1.34      kristaps  164:                /*
                    165:                 * If a title hasn't been set, do so now (by
                    166:                 * implication, date and section also aren't set).
                    167:                 */
1.54      kristaps  168:
1.105     schwarze  169:                man->meta.title = mandoc_strdup("");
                    170:                man->meta.msec = mandoc_strdup("");
1.88      schwarze  171:                man->meta.date = man->quick ? mandoc_strdup("") :
1.128     schwarze  172:                    mandoc_normdate(man, NULL, n->line, n->pos);
1.34      kristaps  173:        }
1.130     schwarze  174:
                    175:        if (man->meta.os_e &&
                    176:            (man->meta.rcsids & (1 << man->meta.os_e)) == 0)
1.131     schwarze  177:                mandoc_msg(MANDOCERR_RCS_MISSING, man->parse, 0, 0,
                    178:                    man->meta.os_e == MANDOC_OS_OPENBSD ?
                    179:                    "(OpenBSD)" : "(NetBSD)");
1.75      kristaps  180: }
                    181:
1.107     schwarze  182: static void
1.75      kristaps  183: check_text(CHKARGS)
                    184: {
                    185:        char            *cp, *p;
                    186:
1.85      schwarze  187:        if (MAN_LITERAL & man->flags)
1.107     schwarze  188:                return;
1.76      schwarze  189:
                    190:        cp = n->string;
                    191:        for (p = cp; NULL != (p = strchr(p, '\t')); p++)
1.99      schwarze  192:                mandoc_msg(MANDOCERR_FI_TAB, man->parse,
                    193:                    n->line, n->pos + (p - cp), NULL);
1.1       kristaps  194: }
                    195:
1.113     schwarze  196: static void
                    197: post_OP(CHKARGS)
                    198: {
                    199:
1.122     schwarze  200:        if (n->child == NULL)
1.113     schwarze  201:                mandoc_msg(MANDOCERR_OP_EMPTY, man->parse,
                    202:                    n->line, n->pos, "OP");
1.122     schwarze  203:        else if (n->child->next != NULL && n->child->next->next != NULL) {
1.113     schwarze  204:                n = n->child->next->next;
                    205:                mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
                    206:                    n->line, n->pos, "OP ... %s", n->string);
                    207:        }
1.1       kristaps  208: }
                    209:
1.107     schwarze  210: static void
1.104     schwarze  211: post_UR(CHKARGS)
1.86      schwarze  212: {
1.114     schwarze  213:        if (n->type == ROFFT_HEAD && n->child == NULL)
1.133     schwarze  214:                mandoc_msg(MANDOCERR_UR_NOHEAD, man->parse,
1.132     schwarze  215:                    n->line, n->pos, roff_name[n->tok]);
1.107     schwarze  216:        check_part(man, n);
1.55      kristaps  217: }
1.16      kristaps  218:
1.107     schwarze  219: static void
1.23      kristaps  220: check_part(CHKARGS)
                    221: {
                    222:
1.114     schwarze  223:        if (n->type == ROFFT_BODY && n->child == NULL)
1.110     schwarze  224:                mandoc_msg(MANDOCERR_BLK_EMPTY, man->parse,
1.123     schwarze  225:                    n->line, n->pos, roff_name[n->tok]);
1.23      kristaps  226: }
                    227:
1.107     schwarze  228: static void
1.17      kristaps  229: check_par(CHKARGS)
                    230: {
                    231:
1.59      kristaps  232:        switch (n->type) {
1.114     schwarze  233:        case ROFFT_BLOCK:
1.122     schwarze  234:                if (n->body->child == NULL)
1.118     schwarze  235:                        roff_node_delete(man, n);
1.59      kristaps  236:                break;
1.114     schwarze  237:        case ROFFT_BODY:
1.122     schwarze  238:                if (n->child == NULL)
1.95      schwarze  239:                        mandoc_vmsg(MANDOCERR_PAR_SKIP,
                    240:                            man->parse, n->line, n->pos,
1.123     schwarze  241:                            "%s empty", roff_name[n->tok]);
1.59      kristaps  242:                break;
1.114     schwarze  243:        case ROFFT_HEAD:
1.122     schwarze  244:                if (n->child != NULL)
1.97      schwarze  245:                        mandoc_vmsg(MANDOCERR_ARG_SKIP,
1.123     schwarze  246:                            man->parse, n->line, n->pos, "%s %s%s",
                    247:                            roff_name[n->tok], n->child->string,
1.122     schwarze  248:                            n->child->next != NULL ? " ..." : "");
1.59      kristaps  249:                break;
                    250:        default:
                    251:                break;
                    252:        }
1.17      kristaps  253: }
                    254:
1.107     schwarze  255: static void
1.83      schwarze  256: post_IP(CHKARGS)
                    257: {
                    258:
                    259:        switch (n->type) {
1.114     schwarze  260:        case ROFFT_BLOCK:
1.122     schwarze  261:                if (n->head->child == NULL && n->body->child == NULL)
1.118     schwarze  262:                        roff_node_delete(man, n);
1.83      schwarze  263:                break;
1.114     schwarze  264:        case ROFFT_BODY:
1.122     schwarze  265:                if (n->parent->head->child == NULL && n->child == NULL)
1.95      schwarze  266:                        mandoc_vmsg(MANDOCERR_PAR_SKIP,
                    267:                            man->parse, n->line, n->pos,
1.123     schwarze  268:                            "%s empty", roff_name[n->tok]);
1.83      schwarze  269:                break;
                    270:        default:
                    271:                break;
                    272:        }
                    273: }
1.17      kristaps  274:
1.107     schwarze  275: static void
1.51      kristaps  276: post_TH(CHKARGS)
                    277: {
1.115     schwarze  278:        struct roff_node *nb;
1.60      schwarze  279:        const char      *p;
1.51      kristaps  280:
1.85      schwarze  281:        free(man->meta.title);
                    282:        free(man->meta.vol);
1.116     schwarze  283:        free(man->meta.os);
1.85      schwarze  284:        free(man->meta.msec);
                    285:        free(man->meta.date);
1.51      kristaps  286:
1.85      schwarze  287:        man->meta.title = man->meta.vol = man->meta.date =
1.116     schwarze  288:            man->meta.msec = man->meta.os = NULL;
1.51      kristaps  289:
1.92      schwarze  290:        nb = n;
                    291:
1.116     schwarze  292:        /* ->TITLE<- MSEC DATE OS VOL */
1.51      kristaps  293:
                    294:        n = n->child;
1.60      schwarze  295:        if (n && n->string) {
                    296:                for (p = n->string; '\0' != *p; p++) {
                    297:                        /* Only warn about this once... */
1.91      schwarze  298:                        if (isalpha((unsigned char)*p) &&
                    299:                            ! isupper((unsigned char)*p)) {
1.102     schwarze  300:                                mandoc_vmsg(MANDOCERR_TITLE_CASE,
1.94      schwarze  301:                                    man->parse, n->line,
                    302:                                    n->pos + (p - n->string),
1.102     schwarze  303:                                    "TH %s", n->string);
1.60      schwarze  304:                                break;
                    305:                        }
                    306:                }
1.85      schwarze  307:                man->meta.title = mandoc_strdup(n->string);
1.105     schwarze  308:        } else {
1.85      schwarze  309:                man->meta.title = mandoc_strdup("");
1.105     schwarze  310:                mandoc_msg(MANDOCERR_TH_NOTITLE, man->parse,
                    311:                    nb->line, nb->pos, "TH");
                    312:        }
1.51      kristaps  313:
1.116     schwarze  314:        /* TITLE ->MSEC<- DATE OS VOL */
1.51      kristaps  315:
1.60      schwarze  316:        if (n)
                    317:                n = n->next;
                    318:        if (n && n->string)
1.85      schwarze  319:                man->meta.msec = mandoc_strdup(n->string);
1.105     schwarze  320:        else {
1.85      schwarze  321:                man->meta.msec = mandoc_strdup("");
1.105     schwarze  322:                mandoc_vmsg(MANDOCERR_MSEC_MISSING, man->parse,
                    323:                    nb->line, nb->pos, "TH %s", man->meta.title);
                    324:        }
1.51      kristaps  325:
1.116     schwarze  326:        /* TITLE MSEC ->DATE<- OS VOL */
1.51      kristaps  327:
1.60      schwarze  328:        if (n)
                    329:                n = n->next;
1.77      schwarze  330:        if (n && n->string && '\0' != n->string[0]) {
1.88      schwarze  331:                man->meta.date = man->quick ?
                    332:                    mandoc_strdup(n->string) :
1.128     schwarze  333:                    mandoc_normdate(man, n->string, n->line, n->pos);
1.92      schwarze  334:        } else {
1.85      schwarze  335:                man->meta.date = mandoc_strdup("");
1.102     schwarze  336:                mandoc_msg(MANDOCERR_DATE_MISSING, man->parse,
                    337:                    n ? n->line : nb->line,
                    338:                    n ? n->pos : nb->pos, "TH");
1.92      schwarze  339:        }
1.51      kristaps  340:
1.116     schwarze  341:        /* TITLE MSEC DATE ->OS<- VOL */
1.51      kristaps  342:
                    343:        if (n && (n = n->next))
1.116     schwarze  344:                man->meta.os = mandoc_strdup(n->string);
1.131     schwarze  345:        else if (man->os_s != NULL)
                    346:                man->meta.os = mandoc_strdup(man->os_s);
                    347:        if (man->meta.os_e == MANDOC_OS_OTHER && man->meta.os != NULL) {
                    348:                if (strstr(man->meta.os, "OpenBSD") != NULL)
                    349:                        man->meta.os_e = MANDOC_OS_OPENBSD;
                    350:                else if (strstr(man->meta.os, "NetBSD") != NULL)
                    351:                        man->meta.os_e = MANDOC_OS_NETBSD;
                    352:        }
1.51      kristaps  353:
1.116     schwarze  354:        /* TITLE MSEC DATE OS ->VOL<- */
1.79      schwarze  355:        /* If missing, use the default VOL name for MSEC. */
1.51      kristaps  356:
                    357:        if (n && (n = n->next))
1.85      schwarze  358:                man->meta.vol = mandoc_strdup(n->string);
                    359:        else if ('\0' != man->meta.msec[0] &&
                    360:            (NULL != (p = mandoc_a2msec(man->meta.msec))))
                    361:                man->meta.vol = mandoc_strdup(p);
1.113     schwarze  362:
                    363:        if (n != NULL && (n = n->next) != NULL)
                    364:                mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse,
                    365:                    n->line, n->pos, "TH ... %s", n->string);
1.51      kristaps  366:
                    367:        /*
                    368:         * Remove the `TH' node after we've processed it for our
                    369:         * meta-data.
                    370:         */
1.118     schwarze  371:        roff_node_delete(man, man->last);
1.51      kristaps  372: }
                    373:
1.107     schwarze  374: static void
1.51      kristaps  375: post_UC(CHKARGS)
                    376: {
                    377:        static const char * const bsd_versions[] = {
                    378:            "3rd Berkeley Distribution",
                    379:            "4th Berkeley Distribution",
                    380:            "4.2 Berkeley Distribution",
                    381:            "4.3 Berkeley Distribution",
                    382:            "4.4 Berkeley Distribution",
                    383:        };
                    384:
                    385:        const char      *p, *s;
                    386:
                    387:        n = n->child;
                    388:
1.114     schwarze  389:        if (n == NULL || n->type != ROFFT_TEXT)
1.51      kristaps  390:                p = bsd_versions[0];
                    391:        else {
                    392:                s = n->string;
                    393:                if (0 == strcmp(s, "3"))
                    394:                        p = bsd_versions[0];
                    395:                else if (0 == strcmp(s, "4"))
                    396:                        p = bsd_versions[1];
                    397:                else if (0 == strcmp(s, "5"))
                    398:                        p = bsd_versions[2];
                    399:                else if (0 == strcmp(s, "6"))
                    400:                        p = bsd_versions[3];
                    401:                else if (0 == strcmp(s, "7"))
                    402:                        p = bsd_versions[4];
                    403:                else
                    404:                        p = bsd_versions[0];
                    405:        }
                    406:
1.116     schwarze  407:        free(man->meta.os);
                    408:        man->meta.os = mandoc_strdup(p);
1.51      kristaps  409: }
                    410:
1.107     schwarze  411: static void
1.51      kristaps  412: post_AT(CHKARGS)
                    413: {
                    414:        static const char * const unix_versions[] = {
                    415:            "7th Edition",
                    416:            "System III",
                    417:            "System V",
                    418:            "System V Release 2",
                    419:        };
                    420:
1.115     schwarze  421:        struct roff_node *nn;
1.51      kristaps  422:        const char      *p, *s;
                    423:
                    424:        n = n->child;
                    425:
1.114     schwarze  426:        if (n == NULL || n->type != ROFFT_TEXT)
1.51      kristaps  427:                p = unix_versions[0];
                    428:        else {
                    429:                s = n->string;
                    430:                if (0 == strcmp(s, "3"))
                    431:                        p = unix_versions[0];
                    432:                else if (0 == strcmp(s, "4"))
                    433:                        p = unix_versions[1];
                    434:                else if (0 == strcmp(s, "5")) {
                    435:                        nn = n->next;
1.114     schwarze  436:                        if (nn != NULL &&
                    437:                            nn->type == ROFFT_TEXT &&
                    438:                            nn->string[0] != '\0')
1.51      kristaps  439:                                p = unix_versions[3];
                    440:                        else
                    441:                                p = unix_versions[2];
                    442:                } else
                    443:                        p = unix_versions[0];
                    444:        }
                    445:
1.116     schwarze  446:        free(man->meta.os);
                    447:        man->meta.os = mandoc_strdup(p);
1.129     schwarze  448: }
                    449:
                    450: static void
                    451: post_in(CHKARGS)
                    452: {
                    453:        char    *s;
                    454:
                    455:        if (n->parent->tok != MAN_TP ||
                    456:            n->parent->type != ROFFT_HEAD ||
                    457:            n->child == NULL ||
                    458:            *n->child->string == '+' ||
                    459:            *n->child->string == '-')
                    460:                return;
                    461:        mandoc_asprintf(&s, "+%s", n->child->string);
                    462:        free(n->child->string);
                    463:        n->child->string = s;
1.70      kristaps  464: }
                    465:
1.107     schwarze  466: static void
1.70      kristaps  467: post_vs(CHKARGS)
                    468: {
                    469:
1.82      schwarze  470:        if (NULL != n->prev)
1.107     schwarze  471:                return;
1.82      schwarze  472:
                    473:        switch (n->parent->tok) {
1.91      schwarze  474:        case MAN_SH:
                    475:        case MAN_SS:
1.127     schwarze  476:        case MAN_PP:
                    477:        case MAN_LP:
                    478:        case MAN_P:
1.95      schwarze  479:                mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,
1.123     schwarze  480:                    "%s after %s", roff_name[n->tok],
                    481:                    roff_name[n->parent->tok]);
1.82      schwarze  482:                /* FALLTHROUGH */
1.119     schwarze  483:        case TOKEN_NONE:
1.91      schwarze  484:                /*
1.82      schwarze  485:                 * Don't warn about this because it occurs in pod2man
                    486:                 * and would cause considerable (unfixable) warnage.
                    487:                 */
1.118     schwarze  488:                roff_node_delete(man, n);
1.82      schwarze  489:                break;
                    490:        default:
                    491:                break;
                    492:        }
1.51      kristaps  493: }

CVSweb