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

Annotation of mandoc/man_validate.c, Revision 1.136

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

CVSweb