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

Annotation of mandoc/validate.c, Revision 1.32

1.32    ! kristaps    1: /* $Id: validate.c,v 1.31 2009/01/16 11:50:54 kristaps Exp $ */
1.1       kristaps    2: /*
                      3:  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
                      4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
                      6:  * purpose with or without fee is hereby granted, provided that the
                      7:  * above copyright notice and this permission notice appear in all
                      8:  * copies.
                      9:  *
                     10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
                     11:  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
                     12:  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
                     13:  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
                     14:  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
                     15:  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
                     16:  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
                     17:  * PERFORMANCE OF THIS SOFTWARE.
                     18:  */
                     19: #include <assert.h>
1.8       kristaps   20: #include <stdlib.h>
1.1       kristaps   21:
                     22: #include "private.h"
                     23:
1.2       kristaps   24:
1.18      kristaps   25: typedef        int     (*v_pre)(struct mdoc *, struct mdoc_node *);
                     26: typedef        int     (*v_post)(struct mdoc *);
1.14      kristaps   27:
                     28:
                     29: struct valids {
1.24      kristaps   30:        v_pre   *pre;
1.17      kristaps   31:        v_post  *post;
1.14      kristaps   32: };
1.1       kristaps   33:
1.11      kristaps   34:
1.23      kristaps   35: static int     pre_display(struct mdoc *, struct mdoc_node *);
1.24      kristaps   36: static int     pre_bd(struct mdoc *, struct mdoc_node *);
                     37: static int     pre_bl(struct mdoc *, struct mdoc_node *);
1.25      kristaps   38: static int     pre_it(struct mdoc *, struct mdoc_node *);
1.20      kristaps   39: static int     pre_prologue(struct mdoc *, struct mdoc_node *);
                     40: static int     pre_prologue(struct mdoc *, struct mdoc_node *);
                     41: static int     pre_prologue(struct mdoc *, struct mdoc_node *);
1.24      kristaps   42:
                     43: static int     headchild_err_ge1(struct mdoc *);
1.27      kristaps   44: static int     headchild_warn_ge1(struct mdoc *);
1.24      kristaps   45: static int     headchild_err_eq0(struct mdoc *);
1.26      kristaps   46: static int     elemchild_err_eq0(struct mdoc *);
1.24      kristaps   47: static int     elemchild_err_ge1(struct mdoc *);
                     48: static int     elemchild_warn_eq0(struct mdoc *);
                     49: static int     bodychild_warn_ge1(struct mdoc *);
1.27      kristaps   50: static int     bodychild_err_eq0(struct mdoc *);
1.26      kristaps   51: static int     elemchild_warn_ge1(struct mdoc *);
1.21      kristaps   52: static int     post_sh(struct mdoc *);
1.24      kristaps   53: static int     post_bl(struct mdoc *);
1.25      kristaps   54: static int     post_it(struct mdoc *);
1.17      kristaps   55:
1.24      kristaps   56: static v_pre   pres_prologue[] = { pre_prologue, NULL };
                     57: static v_pre   pres_d1[] = { pre_display, NULL };
                     58: static v_pre   pres_bd[] = { pre_display, pre_bd, NULL };
                     59: static v_pre   pres_bl[] = { pre_bl, NULL };
1.25      kristaps   60: static v_pre   pres_it[] = { pre_it, NULL };
1.24      kristaps   61:
1.27      kristaps   62: static v_post  posts_bd[] = { headchild_err_eq0, bodychild_warn_ge1, NULL };
1.26      kristaps   63: static v_post  posts_text[] = { elemchild_err_ge1, NULL };
                     64: static v_post  posts_wtext[] = { elemchild_warn_ge1, NULL };
                     65: static v_post  posts_notext[] = { elemchild_err_eq0, NULL };
1.27      kristaps   66: static v_post  posts_wline[] = { headchild_warn_ge1, bodychild_err_eq0, NULL };
                     67: static v_post  posts_sh[] = { headchild_err_ge1, bodychild_warn_ge1, post_sh, NULL };
                     68: static v_post  posts_bl[] = { headchild_err_eq0, bodychild_warn_ge1, post_bl, NULL };
1.25      kristaps   69: static v_post  posts_it[] = { post_it, NULL };
1.24      kristaps   70: static v_post  posts_ss[] = { headchild_err_ge1, NULL };
                     71: static v_post  posts_pp[] = { elemchild_warn_eq0, NULL };
                     72: static v_post  posts_d1[] = { headchild_err_ge1, NULL };
1.9       kristaps   73:
1.12      kristaps   74:
1.9       kristaps   75: const  struct valids mdoc_valids[MDOC_MAX] = {
1.17      kristaps   76:        { NULL, NULL }, /* \" */
1.26      kristaps   77:        { pres_prologue, posts_text }, /* Dd */
1.24      kristaps   78:        { pres_prologue, NULL }, /* Dt */
                     79:        { pres_prologue, NULL }, /* Os */
1.26      kristaps   80:        /* FIXME: preceding Pp. */
                     81:        /* FIXME: NAME section internal ordering. */
1.28      kristaps   82:        /* FIXME: can only be a child of root. */
1.26      kristaps   83:        { NULL, posts_sh }, /* Sh */
                     84:        /* FIXME: preceding Pp. */
1.28      kristaps   85:        /* FIXME: can only be a child of Sh. */
1.26      kristaps   86:        { NULL, posts_ss }, /* Ss */
                     87:        /* FIXME: proceeding... */
                     88:        { NULL, posts_pp }, /* Pp */
1.24      kristaps   89:        { pres_d1, posts_d1 }, /* D1 */
                     90:        { pres_d1, posts_d1 }, /* Dl */
1.26      kristaps   91:         /* FIXME: preceding Pp. */
                     92:        { pres_bd, posts_bd }, /* Bd */
1.17      kristaps   93:        { NULL, NULL }, /* Ed */
1.26      kristaps   94:        /* FIXME: preceding Pp. */
                     95:        { pres_bl, posts_bl }, /* Bl */
1.17      kristaps   96:        { NULL, NULL }, /* El */
1.25      kristaps   97:        { pres_it, posts_it }, /* It */
1.26      kristaps   98:        { NULL, posts_text }, /* Ad */
                     99:        /* FIXME */
                    100:        { NULL, NULL }, /* An */
1.17      kristaps  101:        { NULL, NULL }, /* Ar */
1.26      kristaps  102:
                    103:        { NULL, posts_text }, /* Cd */ /* FIXME: section 4 only. */
1.17      kristaps  104:        { NULL, NULL }, /* Cm */
1.26      kristaps  105:        { NULL, posts_text }, /* Dv */
                    106:        { NULL, posts_text }, /* Er */ /* FIXME: section 2 only. */
                    107:        { NULL, posts_text }, /* Ev */
                    108:        { NULL, posts_notext }, /* Ex */ /* FIXME: sections 1,6,8 only. */ /* -std required */
                    109:        { NULL, posts_text }, /* Fa */
                    110:        { NULL, NULL }, /* Fd */ /* FIXME: SYNOPSIS section. */
1.17      kristaps  111:        { NULL, NULL }, /* Fl */
1.26      kristaps  112:        { NULL, posts_text }, /* Fn */
1.17      kristaps  113:        { NULL, NULL }, /* Ft */
1.26      kristaps  114:        { NULL, posts_text }, /* Ic */
                    115:        { NULL, posts_wtext }, /* In */
                    116:        { NULL, posts_text }, /* Li */
                    117:        { NULL, posts_wtext }, /* Nd */
                    118:        { NULL, NULL }, /* Nm */  /* FIXME: If name not set? */
1.27      kristaps  119:        { NULL, posts_wline }, /* Op */
1.17      kristaps  120:        { NULL, NULL }, /* Ot */
                    121:        { NULL, NULL }, /* Pa */
1.26      kristaps  122:        { NULL, posts_notext }, /* Rv */ /* -std required */
                    123:        { NULL, posts_notext }, /* St */ /* arg required */
                    124:        { NULL, posts_text }, /* Va */
                    125:        { NULL, posts_text }, /* Vt */
                    126:        { NULL, NULL }, /* Xr */ /* FIXME */
                    127:        { NULL, posts_text }, /* %A */
                    128:        { NULL, posts_text }, /* %B */
                    129:        { NULL, posts_text }, /* %D */
                    130:        { NULL, posts_text }, /* %I */
                    131:        { NULL, posts_text }, /* %J */
                    132:        { NULL, posts_text }, /* %N */
                    133:        { NULL, posts_text }, /* %O */
                    134:        { NULL, posts_text }, /* %P */
                    135:        { NULL, posts_text }, /* %R */
                    136:        { NULL, posts_text }, /* %T */
                    137:        { NULL, posts_text }, /* %V */
1.17      kristaps  138:        { NULL, NULL }, /* Ac */
                    139:        { NULL, NULL }, /* Ao */
1.27      kristaps  140:        { NULL, posts_wline }, /* Aq */
1.17      kristaps  141:        { NULL, NULL }, /* At */ /* FIXME */
                    142:        { NULL, NULL }, /* Bc */
                    143:        { NULL, NULL }, /* Bf */
                    144:        { NULL, NULL }, /* Bo */
1.27      kristaps  145:        { NULL, posts_wline }, /* Bq */
1.17      kristaps  146:        { NULL, NULL }, /* Bsx */
                    147:        { NULL, NULL }, /* Bx */
1.26      kristaps  148:        { NULL, NULL }, /* Db */ /* FIXME: boolean */
1.17      kristaps  149:        { NULL, NULL }, /* Dc */
                    150:        { NULL, NULL }, /* Do */
1.27      kristaps  151:        { NULL, posts_wline }, /* Dq */
1.17      kristaps  152:        { NULL, NULL }, /* Ec */
                    153:        { NULL, NULL }, /* Ef */ /* -symbolic, etc. */
1.26      kristaps  154:        { NULL, posts_text }, /* Em */
1.17      kristaps  155:        { NULL, NULL }, /* Eo */
                    156:        { NULL, NULL }, /* Fx */
1.26      kristaps  157:        { NULL, posts_text }, /* Ms */ /* FIXME: which symbols? */
                    158:        { NULL, posts_notext }, /* No */
                    159:        { NULL, posts_notext }, /* Ns */
1.17      kristaps  160:        { NULL, NULL }, /* Nx */
                    161:        { NULL, NULL }, /* Ox */
                    162:        { NULL, NULL }, /* Pc */
1.26      kristaps  163:        { NULL, NULL }, /* Pf */ /* FIXME: 2 or more arguments */
1.17      kristaps  164:        { NULL, NULL }, /* Po */
1.27      kristaps  165:        { NULL, posts_wline }, /* Pq */ /* FIXME: ignore following Sh/Ss */
1.17      kristaps  166:        { NULL, NULL }, /* Qc */
1.27      kristaps  167:        { NULL, posts_wline }, /* Ql */
1.17      kristaps  168:        { NULL, NULL }, /* Qo */
1.27      kristaps  169:        { NULL, posts_wline }, /* Qq */
1.17      kristaps  170:        { NULL, NULL }, /* Re */
                    171:        { NULL, NULL }, /* Rs */
                    172:        { NULL, NULL }, /* Sc */
                    173:        { NULL, NULL }, /* So */
1.27      kristaps  174:        { NULL, posts_wline }, /* Sq */
1.26      kristaps  175:        { NULL, NULL }, /* Sm */ /* FIXME: boolean */
                    176:        { NULL, posts_text }, /* Sx */
                    177:        { NULL, posts_text }, /* Sy */
                    178:        { NULL, posts_text }, /* Tn */
1.17      kristaps  179:        { NULL, NULL }, /* Ux */
                    180:        { NULL, NULL }, /* Xc */
                    181:        { NULL, NULL }, /* Xo */
                    182:        { NULL, NULL }, /* Fo */
                    183:        { NULL, NULL }, /* Fc */
                    184:        { NULL, NULL }, /* Oo */
                    185:        { NULL, NULL }, /* Oc */
                    186:        { NULL, NULL }, /* Bk */
                    187:        { NULL, NULL }, /* Ek */
1.26      kristaps  188:        { NULL, posts_notext }, /* Bt */
1.17      kristaps  189:        { NULL, NULL }, /* Hf */
                    190:        { NULL, NULL }, /* Fr */
1.26      kristaps  191:        { NULL, posts_notext }, /* Ud */
1.9       kristaps  192: };
1.6       kristaps  193:
                    194:
                    195: static int
1.27      kristaps  196: bodychild_err_eq0(struct mdoc *mdoc)
                    197: {
                    198:
                    199:        if (MDOC_BODY != mdoc->last->type)
                    200:                return(1);
                    201:        if (NULL == mdoc->last->child)
                    202:                return(1);
1.31      kristaps  203:        return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children"));
1.27      kristaps  204: }
                    205:
                    206:
                    207: static int
1.24      kristaps  208: bodychild_warn_ge1(struct mdoc *mdoc)
1.6       kristaps  209: {
                    210:
1.17      kristaps  211:        if (MDOC_BODY != mdoc->last->type)
1.8       kristaps  212:                return(1);
1.17      kristaps  213:        if (mdoc->last->child)
1.9       kristaps  214:                return(1);
1.31      kristaps  215:        return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more body children"));
1.8       kristaps  216: }
1.1       kristaps  217:
                    218:
1.8       kristaps  219: static int
1.24      kristaps  220: elemchild_warn_eq0(struct mdoc *mdoc)
1.22      kristaps  221: {
                    222:
                    223:        assert(MDOC_ELEM == mdoc->last->type);
                    224:        if (NULL == mdoc->last->child)
                    225:                return(1);
1.24      kristaps  226:        return(mdoc_pwarn(mdoc, mdoc->last->child->line,
1.31      kristaps  227:                        mdoc->last->child->pos, WARN_SYNTAX, "macro suggests no parameters"));
1.22      kristaps  228: }
                    229:
                    230:
                    231: static int
1.26      kristaps  232: elemchild_warn_ge1(struct mdoc *mdoc)
                    233: {
                    234:
                    235:        assert(MDOC_ELEM == mdoc->last->type);
                    236:        if (mdoc->last->child)
                    237:                return(1);
1.31      kristaps  238:        return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));
1.26      kristaps  239: }
                    240:
                    241:
                    242: static int
                    243: elemchild_err_eq0(struct mdoc *mdoc)
                    244: {
                    245:
                    246:        assert(MDOC_ELEM == mdoc->last->type);
                    247:        if (NULL == mdoc->last->child)
                    248:                return(1);
1.31      kristaps  249:        return(mdoc_err(mdoc, "macro expects no parameters"));
1.26      kristaps  250: }
                    251:
                    252:
                    253: static int
1.24      kristaps  254: elemchild_err_ge1(struct mdoc *mdoc)
1.8       kristaps  255: {
1.1       kristaps  256:
1.21      kristaps  257:        assert(MDOC_ELEM == mdoc->last->type);
1.17      kristaps  258:        if (mdoc->last->child)
1.9       kristaps  259:                return(1);
1.31      kristaps  260:        return(mdoc_err(mdoc, "macro expects one or more parameters"));
1.1       kristaps  261: }
                    262:
                    263:
1.9       kristaps  264: static int
1.24      kristaps  265: headchild_err_eq0(struct mdoc *mdoc)
                    266: {
                    267:
                    268:        if (MDOC_HEAD != mdoc->last->type)
                    269:                return(1);
                    270:        if (NULL == mdoc->last->child)
                    271:                return(1);
                    272:        return(mdoc_perr(mdoc, mdoc->last->child->line,
1.31      kristaps  273:                        mdoc->last->child->pos, "macro expects no parameters"));
1.24      kristaps  274: }
                    275:
                    276:
                    277: static int
1.27      kristaps  278: headchild_warn_ge1(struct mdoc *mdoc)
                    279: {
                    280:
                    281:        if (MDOC_HEAD != mdoc->last->type)
                    282:                return(1);
                    283:        if (mdoc->last->child)
                    284:                return(1);
1.31      kristaps  285:        return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));
1.27      kristaps  286: }
                    287:
                    288:
                    289: static int
1.24      kristaps  290: headchild_err_ge1(struct mdoc *mdoc)
1.14      kristaps  291: {
                    292:
1.17      kristaps  293:        if (MDOC_HEAD != mdoc->last->type)
1.14      kristaps  294:                return(1);
1.21      kristaps  295:        if (mdoc->last->child)
1.11      kristaps  296:                return(1);
1.31      kristaps  297:        return(mdoc_err(mdoc, "macro expects one or more parameters"));
1.14      kristaps  298: }
                    299:
                    300:
                    301: static int
1.23      kristaps  302: pre_display(struct mdoc *mdoc, struct mdoc_node *node)
                    303: {
                    304:        struct mdoc_node *n;
                    305:
1.24      kristaps  306:        if (MDOC_BLOCK != node->type)
                    307:                return(1);
                    308:
1.32    ! kristaps  309:        assert(mdoc->last);
        !           310:        for (n = mdoc->last->parent; n; n = n->parent)
1.23      kristaps  311:                if (MDOC_BLOCK == n->type)
1.25      kristaps  312:                        if (MDOC_Bd == n->tok)
1.23      kristaps  313:                                break;
                    314:        if (NULL == n)
                    315:                return(1);
1.31      kristaps  316:        return(mdoc_nerr(mdoc, node, "displays may not be nested"));
1.23      kristaps  317: }
                    318:
                    319:
                    320: static int
1.24      kristaps  321: pre_bl(struct mdoc *mdoc, struct mdoc_node *node)
                    322: {
                    323:        int              type, err;
                    324:        struct mdoc_arg *argv;
                    325:        size_t           i, argc;
                    326:
                    327:        if (MDOC_BLOCK != node->type)
                    328:                return(1);
1.25      kristaps  329:        assert(MDOC_Bl == node->tok);
1.24      kristaps  330:
                    331:        argv = NULL;
                    332:        argc = node->data.block.argc;
                    333:
                    334:        for (i = type = err = 0; i < argc; i++) {
                    335:                argv = &node->data.block.argv[(int)i];
                    336:                assert(argv);
                    337:                switch (argv->arg) {
                    338:                case (MDOC_Bullet):
                    339:                        /* FALLTHROUGH */
                    340:                case (MDOC_Dash):
                    341:                        /* FALLTHROUGH */
                    342:                case (MDOC_Enum):
                    343:                        /* FALLTHROUGH */
                    344:                case (MDOC_Hyphen):
                    345:                        /* FALLTHROUGH */
                    346:                case (MDOC_Item):
                    347:                        /* FALLTHROUGH */
                    348:                case (MDOC_Tag):
                    349:                        /* FALLTHROUGH */
                    350:                case (MDOC_Diag):
                    351:                        /* FALLTHROUGH */
                    352:                case (MDOC_Hang):
                    353:                        /* FALLTHROUGH */
                    354:                case (MDOC_Ohang):
                    355:                        /* FALLTHROUGH */
                    356:                case (MDOC_Inset):
1.26      kristaps  357:                        /* FALLTHROUGH */
                    358:                case (MDOC_Column):
1.24      kristaps  359:                        if (type)
                    360:                                err++;
                    361:                        type++;
                    362:                        break;
                    363:                default:
                    364:                        break;
                    365:                }
                    366:        }
                    367:        if (0 == type)
1.31      kristaps  368:                return(mdoc_err(mdoc, "no list type specified"));
1.24      kristaps  369:        if (0 == err)
                    370:                return(1);
                    371:        assert(argv);
                    372:        return(mdoc_perr(mdoc, argv->line,
1.31      kristaps  373:                        argv->pos, "only one list type possible"));
1.24      kristaps  374: }
                    375:
                    376:
                    377: static int
                    378: pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
                    379: {
                    380:        int              type, err;
                    381:        struct mdoc_arg *argv;
                    382:        size_t           i, argc;
                    383:
                    384:        if (MDOC_BLOCK != node->type)
                    385:                return(1);
1.25      kristaps  386:        assert(MDOC_Bd == node->tok);
1.24      kristaps  387:
                    388:        argv = NULL;
                    389:        argc = node->data.block.argc;
                    390:
                    391:        for (err = i = type = 0; 0 == err && i < argc; i++) {
                    392:                argv = &node->data.block.argv[(int)i];
                    393:                assert(argv);
                    394:                switch (argv->arg) {
                    395:                case (MDOC_Ragged):
                    396:                        /* FALLTHROUGH */
                    397:                case (MDOC_Unfilled):
                    398:                        /* FALLTHROUGH */
1.29      kristaps  399:                case (MDOC_Filled):
                    400:                        /* FALLTHROUGH */
1.24      kristaps  401:                case (MDOC_Literal):
                    402:                        /* FALLTHROUGH */
                    403:                case (MDOC_File):
                    404:                        if (type)
                    405:                                err++;
                    406:                        type++;
                    407:                        break;
                    408:                default:
                    409:                        break;
                    410:                }
                    411:        }
                    412:        if (0 == type)
1.31      kristaps  413:                return(mdoc_err(mdoc, "no display type specified"));
1.24      kristaps  414:        if (0 == err)
                    415:                return(1);
                    416:        assert(argv);
                    417:        return(mdoc_perr(mdoc, argv->line,
1.31      kristaps  418:                        argv->pos, "only one display type possible"));
1.24      kristaps  419: }
                    420:
                    421:
                    422: static int
1.25      kristaps  423: pre_it(struct mdoc *mdoc, struct mdoc_node *node)
                    424: {
                    425:
                    426:        if (MDOC_BLOCK != mdoc->last->type)
                    427:                return(1);
                    428:        assert(MDOC_It == mdoc->last->tok);
                    429:
                    430:        if (MDOC_BODY != mdoc->last->parent->type)
1.31      kristaps  431:                return(mdoc_nerr(mdoc, node, "invalid macro parent `%s'", mdoc_macronames[mdoc->last->parent->tok]));
1.25      kristaps  432:        if (MDOC_Bl != mdoc->last->parent->tok)
1.31      kristaps  433:                return(mdoc_nerr(mdoc, node, "invalid macro parent `%s'", mdoc_macronames[mdoc->last->parent->tok]));
1.25      kristaps  434:
                    435:        return(1);
                    436: }
                    437:
                    438:
                    439: static int
1.20      kristaps  440: pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)
                    441: {
                    442:
                    443:        if (SEC_PROLOGUE != mdoc->sec_lastn)
1.31      kristaps  444:                return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue"));
1.20      kristaps  445:        assert(MDOC_ELEM == node->type);
                    446:
                    447:        /* Check for ordering. */
                    448:
1.25      kristaps  449:        switch (node->tok) {
1.20      kristaps  450:        case (MDOC_Os):
                    451:                if (mdoc->meta.title[0] && mdoc->meta.date)
                    452:                        break;
1.31      kristaps  453:                return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
1.20      kristaps  454:        case (MDOC_Dt):
                    455:                if (0 == mdoc->meta.title[0] && mdoc->meta.date)
                    456:                        break;
1.31      kristaps  457:                return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
1.20      kristaps  458:        case (MDOC_Dd):
                    459:                if (0 == mdoc->meta.title[0] && 0 == mdoc->meta.date)
                    460:                        break;
1.31      kristaps  461:                return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
1.20      kristaps  462:        default:
                    463:                abort();
                    464:                /* NOTREACHED */
                    465:        }
                    466:
                    467:        /* Check for repetition. */
                    468:
1.25      kristaps  469:        switch (node->tok) {
1.20      kristaps  470:        case (MDOC_Os):
                    471:                if (0 == mdoc->meta.os[0])
                    472:                        return(1);
                    473:                break;
                    474:        case (MDOC_Dd):
                    475:                if (0 == mdoc->meta.date)
                    476:                        return(1);
                    477:                break;
                    478:        case (MDOC_Dt):
                    479:                if (0 == mdoc->meta.title[0])
                    480:                        return(1);
                    481:                break;
                    482:        default:
                    483:                abort();
                    484:                /* NOTREACHED */
                    485:        }
                    486:
1.31      kristaps  487:        return(mdoc_nerr(mdoc, node, "prologue macro repeated"));
1.20      kristaps  488: }
                    489:
                    490:
1.25      kristaps  491: /* Warn if `Bl' type-specific syntax isn't reflected in items. */
                    492: static int
                    493: post_it(struct mdoc *mdoc)
                    494: {
                    495:        int               type, sv;
                    496: #define        TYPE_NONE        (0)
                    497: #define        TYPE_BODY        (1)
                    498: #define        TYPE_HEAD        (2)
                    499:        size_t            i, argc;
                    500:        struct mdoc_node *n;
                    501:
                    502:        if (MDOC_BLOCK != mdoc->last->type)
                    503:                return(1);
                    504:
                    505:        assert(MDOC_It == mdoc->last->tok);
                    506:
                    507:        n = mdoc->last->parent;
                    508:        assert(n);
                    509:        assert(MDOC_Bl == n->tok);
                    510:
                    511:        n = n->parent;
                    512:        assert(MDOC_BLOCK == n->type);
                    513:        assert(MDOC_Bl == n->tok);
                    514:
                    515:        argc = n->data.block.argc;
                    516:        type = TYPE_NONE;
1.26      kristaps  517:
                    518:        /* Some types require block-head, some not. */
1.25      kristaps  519:
                    520:        for (i = 0; TYPE_NONE == type && i < argc; i++)
                    521:                switch (n->data.block.argv[(int)i].arg) {
                    522:                case (MDOC_Tag):
                    523:                        /* FALLTHROUGH */
                    524:                case (MDOC_Diag):
                    525:                        /* FALLTHROUGH */
                    526:                case (MDOC_Hang):
                    527:                        /* FALLTHROUGH */
                    528:                case (MDOC_Ohang):
                    529:                        /* FALLTHROUGH */
                    530:                case (MDOC_Inset):
                    531:                        type = TYPE_HEAD;
                    532:                        sv = n->data.block.argv[(int)i].arg;
                    533:                        break;
                    534:                case (MDOC_Bullet):
                    535:                        /* FALLTHROUGH */
                    536:                case (MDOC_Dash):
                    537:                        /* FALLTHROUGH */
                    538:                case (MDOC_Enum):
                    539:                        /* FALLTHROUGH */
                    540:                case (MDOC_Hyphen):
                    541:                        /* FALLTHROUGH */
                    542:                case (MDOC_Item):
                    543:                        /* FALLTHROUGH */
                    544:                case (MDOC_Column):
                    545:                        type = TYPE_BODY;
                    546:                        sv = n->data.block.argv[(int)i].arg;
                    547:                        break;
                    548:                default:
                    549:                        break;
                    550:                }
                    551:
                    552:        assert(TYPE_NONE != type);
                    553:
                    554:        if (TYPE_HEAD == type) {
                    555:                if (NULL == (n = mdoc->last->data.block.head)) {
1.31      kristaps  556:                        if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters"))
1.25      kristaps  557:                                return(0);
                    558:                } else if (NULL == n->child)
1.31      kristaps  559:                        if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters"))
1.25      kristaps  560:                                return(0);
                    561:
                    562:                if (NULL == (n = mdoc->last->data.block.body)) {
1.31      kristaps  563:                        if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))
1.25      kristaps  564:                                return(0);
                    565:                } else if (NULL == n->child)
1.31      kristaps  566:                        if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))
1.25      kristaps  567:                                return(0);
                    568:
                    569:                return(1);
                    570:        }
                    571:
                    572:        if (NULL == (n = mdoc->last->data.block.head)) {
1.31      kristaps  573:                if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters"))
1.25      kristaps  574:                        return(0);
                    575:        } else if (NULL == n->child)
1.31      kristaps  576:                if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters"))
1.25      kristaps  577:                        return(0);
                    578:
                    579:        if ((n = mdoc->last->data.block.body) && n->child)
1.31      kristaps  580:                if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))
1.25      kristaps  581:                        return(0);
                    582:
1.26      kristaps  583:        if (MDOC_Column != sv)
                    584:                return(1);
                    585:
                    586:        /* Make sure the number of columns is sane. */
                    587:
                    588:        sv = mdoc->last->parent->parent->data.block.argv->sz;
                    589:        n = mdoc->last->data.block.head->child;
1.25      kristaps  590:
1.26      kristaps  591:        for (i = 0; n; n = n->next)
                    592:                i++;
                    593:
                    594:        if (i == (size_t)sv)
                    595:                return(1);
1.31      kristaps  596:        return(mdoc_err(mdoc, "expected %d list columns, have %d", sv, (int)i));
1.25      kristaps  597:
                    598: #undef TYPE_NONE
                    599: #undef TYPE_BODY
                    600: #undef TYPE_HEAD
                    601: }
                    602:
                    603:
                    604: /* Make sure that only `It' macros are our body-children. */
1.24      kristaps  605: static int
                    606: post_bl(struct mdoc *mdoc)
                    607: {
                    608:        struct mdoc_node *n;
                    609:
                    610:        if (MDOC_BODY != mdoc->last->type)
                    611:                return(1);
1.25      kristaps  612:        assert(MDOC_Bl == mdoc->last->tok);
1.24      kristaps  613:
                    614:        for (n = mdoc->last->child; n; n = n->next) {
                    615:                if (MDOC_BLOCK == n->type)
1.25      kristaps  616:                        if (MDOC_It == n->tok)
1.24      kristaps  617:                                continue;
                    618:                break;
                    619:        }
                    620:        if (NULL == n)
                    621:                return(1);
1.31      kristaps  622:        return(mdoc_nerr(mdoc, n, "invalid child of parent macro `Bl'"));
1.24      kristaps  623: }
                    624:
                    625:
1.25      kristaps  626: /* Warn if conventional sections are out of order. */
1.20      kristaps  627: static int
1.21      kristaps  628: post_sh(struct mdoc *mdoc)
1.14      kristaps  629: {
1.21      kristaps  630:        enum mdoc_sec     sec;
                    631:        int               i;
                    632:        struct mdoc_node *n;
                    633:        char             *args[MDOC_LINEARG_MAX];
                    634:
                    635:        if (MDOC_HEAD != mdoc->last->type)
                    636:                return(1);
                    637:
1.25      kristaps  638:        assert(MDOC_Sh == mdoc->last->tok);
1.21      kristaps  639:
                    640:        n = mdoc->last->child;
                    641:        assert(n);
1.14      kristaps  642:
1.21      kristaps  643:        for (i = 0; n && i < MDOC_LINEARG_MAX; n = n->next, i++) {
                    644:                assert(MDOC_TEXT == n->type);
                    645:                assert(NULL == n->child);
                    646:                assert(n->data.text.string);
                    647:                args[i] = n->data.text.string;
                    648:        }
                    649:
                    650:        sec = mdoc_atosec((size_t)i, (const char **)args);
                    651:        if (SEC_CUSTOM == sec)
                    652:                return(1);
                    653:        if (sec > mdoc->sec_lastn)
                    654:                return(1);
                    655:
                    656:        if (sec == mdoc->sec_lastn)
1.31      kristaps  657:                return(mdoc_warn(mdoc, WARN_SYNTAX, "section repeated"));
                    658:        return(mdoc_warn(mdoc, WARN_SYNTAX, "section out of conventional order"));
1.11      kristaps  659: }
                    660:
                    661:
1.17      kristaps  662: int
1.18      kristaps  663: mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node)
1.11      kristaps  664: {
1.24      kristaps  665:        v_pre           *p;
1.18      kristaps  666:
1.25      kristaps  667:        /* TODO: character-escape checks. */
                    668:
                    669:        if (MDOC_TEXT == node->type)
1.18      kristaps  670:                return(1);
1.25      kristaps  671:        assert(MDOC_ROOT != node->type);
1.11      kristaps  672:
1.25      kristaps  673:        if (NULL == mdoc_valids[node->tok].pre)
1.11      kristaps  674:                return(1);
1.25      kristaps  675:        for (p = mdoc_valids[node->tok].pre; *p; p++)
1.24      kristaps  676:                if ( ! (*p)(mdoc, node))
                    677:                        return(0);
                    678:        return(1);
1.11      kristaps  679: }
                    680:
                    681:
1.17      kristaps  682: int
1.18      kristaps  683: mdoc_valid_post(struct mdoc *mdoc)
1.11      kristaps  684: {
1.17      kristaps  685:        v_post          *p;
1.11      kristaps  686:
1.25      kristaps  687:        if (MDOC_TEXT == mdoc->last->type)
                    688:                return(1);
                    689:        if (MDOC_ROOT == mdoc->last->type)
1.8       kristaps  690:                return(1);
1.14      kristaps  691:
1.25      kristaps  692:        if (NULL == mdoc_valids[mdoc->last->tok].post)
1.9       kristaps  693:                return(1);
1.25      kristaps  694:        for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
1.18      kristaps  695:                if ( ! (*p)(mdoc))
1.17      kristaps  696:                        return(0);
1.11      kristaps  697:
1.14      kristaps  698:        return(1);
1.11      kristaps  699: }
1.14      kristaps  700:

CVSweb