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

Annotation of mandoc/mdoc_validate.c, Revision 1.18

1.18    ! kristaps    1: /*     $Id: mdoc_validate.c,v 1.17 2009/06/27 09:03:03 kristaps Exp $ */
1.1       kristaps    2: /*
1.7       kristaps    3:  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1       kristaps    4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
1.5       kristaps    6:  * purpose with or without fee is hereby granted, provided that the above
                      7:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps    8:  *
1.5       kristaps    9:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   16:  */
                     17: #include <sys/types.h>
                     18:
                     19: #include <assert.h>
                     20: #include <ctype.h>
                     21: #include <stdarg.h>
                     22: #include <stdlib.h>
1.2       kristaps   23: #include <string.h>
1.1       kristaps   24:
                     25: #include "libmdoc.h"
1.18    ! kristaps   26: #include "libmandoc.h"
1.1       kristaps   27:
                     28: /* FIXME: .Bl -diag can't have non-text children in HEAD. */
                     29: /* TODO: ignoring Pp (it's superfluous in some invocations). */
                     30:
                     31: #define        PRE_ARGS        struct mdoc *mdoc, const struct mdoc_node *n
                     32: #define        POST_ARGS       struct mdoc *mdoc
                     33:
                     34: enum   merr {
1.2       kristaps   35:        ETOOLONG,
1.1       kristaps   36:        EESCAPE,
                     37:        EPRINT,
                     38:        ENODATA,
                     39:        ENOPROLOGUE,
                     40:        ELINE,
                     41:        EATT,
                     42:        ENAME,
                     43:        ELISTTYPE,
                     44:        EDISPTYPE,
                     45:        EMULTIDISP,
1.12      kristaps   46:        ESECNAME,
1.1       kristaps   47:        EMULTILIST,
                     48:        EARGREP,
                     49:        EBOOL,
1.14      kristaps   50:        ECOLMIS,
1.1       kristaps   51:        ENESTDISP
                     52: };
                     53:
                     54: enum   mwarn {
1.4       kristaps   55:        WPRINT,
1.8       kristaps   56:        WNOWIDTH,
                     57:        WMISSWIDTH,
1.1       kristaps   58:        WESCAPE,
1.8       kristaps   59:        WDEPCOL,
1.1       kristaps   60:        WWRONGMSEC,
                     61:        WSECOOO,
                     62:        WSECREP,
                     63:        WBADSTAND,
                     64:        WNAMESECINC,
                     65:        WNOMULTILINE,
                     66:        WMULTILINE,
                     67:        WLINE,
                     68:        WNOLINE,
                     69:        WPROLOOO,
                     70:        WPROLREP,
                     71:        WARGVAL,
                     72:        WBADSEC,
                     73:        WBADMSEC
                     74: };
                     75:
                     76: typedef        int     (*v_pre)(PRE_ARGS);
                     77: typedef        int     (*v_post)(POST_ARGS);
                     78:
                     79: struct valids {
                     80:        v_pre   *pre;
                     81:        v_post  *post;
                     82: };
                     83:
                     84: static int     pwarn(struct mdoc *, int, int, enum mwarn);
                     85: static int     perr(struct mdoc *, int, int, enum merr);
                     86: static int     check_parent(PRE_ARGS, int, enum mdoc_type);
                     87: static int     check_msec(PRE_ARGS, ...);
                     88: static int     check_sec(PRE_ARGS, ...);
                     89: static int     check_stdarg(PRE_ARGS);
                     90: static int     check_text(struct mdoc *, int, int, const char *);
                     91: static int     check_argv(struct mdoc *,
                     92:                        const struct mdoc_node *,
                     93:                        const struct mdoc_argv *);
                     94: static int     check_args(struct mdoc *,
                     95:                        const struct mdoc_node *);
                     96: static int     err_child_lt(struct mdoc *, const char *, int);
                     97: static int     warn_child_lt(struct mdoc *, const char *, int);
                     98: static int     err_child_gt(struct mdoc *, const char *, int);
                     99: static int     warn_child_gt(struct mdoc *, const char *, int);
                    100: static int     err_child_eq(struct mdoc *, const char *, int);
                    101: static int     warn_child_eq(struct mdoc *, const char *, int);
1.4       kristaps  102: static int     warn_print(struct mdoc *, int, int);
1.2       kristaps  103: static int     warn_count(struct mdoc *, const char *,
1.1       kristaps  104:                        int, const char *, int);
1.2       kristaps  105: static int     err_count(struct mdoc *, const char *,
1.1       kristaps  106:                        int, const char *, int);
                    107: static int     pre_an(PRE_ARGS);
                    108: static int     pre_bd(PRE_ARGS);
                    109: static int     pre_bl(PRE_ARGS);
                    110: static int     pre_cd(PRE_ARGS);
                    111: static int     pre_dd(PRE_ARGS);
                    112: static int     pre_display(PRE_ARGS);
                    113: static int     pre_dt(PRE_ARGS);
                    114: static int     pre_er(PRE_ARGS);
                    115: static int     pre_ex(PRE_ARGS);
                    116: static int     pre_fd(PRE_ARGS);
                    117: static int     pre_it(PRE_ARGS);
                    118: static int     pre_lb(PRE_ARGS);
                    119: static int     pre_os(PRE_ARGS);
                    120: static int     pre_rv(PRE_ARGS);
                    121: static int     pre_sh(PRE_ARGS);
                    122: static int     pre_ss(PRE_ARGS);
                    123: static int     herr_ge1(POST_ARGS);
                    124: static int     hwarn_le1(POST_ARGS);
                    125: static int     herr_eq0(POST_ARGS);
                    126: static int     eerr_eq0(POST_ARGS);
                    127: static int     eerr_le2(POST_ARGS);
                    128: static int     eerr_eq1(POST_ARGS);
                    129: static int     eerr_ge1(POST_ARGS);
                    130: static int     ewarn_eq0(POST_ARGS);
                    131: static int     ewarn_eq1(POST_ARGS);
                    132: static int     bwarn_ge1(POST_ARGS);
                    133: static int     hwarn_eq1(POST_ARGS);
                    134: static int     ewarn_ge1(POST_ARGS);
                    135: static int     ebool(POST_ARGS);
                    136: static int     post_an(POST_ARGS);
                    137: static int     post_args(POST_ARGS);
                    138: static int     post_at(POST_ARGS);
                    139: static int     post_bf(POST_ARGS);
                    140: static int     post_bl(POST_ARGS);
1.14      kristaps  141: static int     post_bl_head(POST_ARGS);
1.1       kristaps  142: static int     post_it(POST_ARGS);
                    143: static int     post_nm(POST_ARGS);
                    144: static int     post_root(POST_ARGS);
                    145: static int     post_sh(POST_ARGS);
                    146: static int     post_sh_body(POST_ARGS);
                    147: static int     post_sh_head(POST_ARGS);
                    148: static int     post_st(POST_ARGS);
                    149:
1.2       kristaps  150: #define        vwarn(m, t) nwarn((m), (m)->last, (t))
                    151: #define        verr(m, t) nerr((m), (m)->last, (t))
1.1       kristaps  152: #define        nwarn(m, n, t) pwarn((m), (n)->line, (n)->pos, (t))
                    153: #define        nerr(m, n, t) perr((m), (n)->line, (n)->pos, (t))
                    154:
                    155: static v_pre   pres_an[] = { pre_an, NULL };
                    156: static v_pre   pres_bd[] = { pre_display, pre_bd, NULL };
                    157: static v_pre   pres_bl[] = { pre_bl, NULL };
                    158: static v_pre   pres_cd[] = { pre_cd, NULL };
1.12      kristaps  159: static v_pre   pres_dd[] = { pre_dd, NULL };
1.1       kristaps  160: static v_pre   pres_d1[] = { pre_display, NULL };
1.12      kristaps  161: static v_pre   pres_dt[] = { pre_dt, NULL };
1.1       kristaps  162: static v_pre   pres_er[] = { pre_er, NULL };
                    163: static v_pre   pres_ex[] = { pre_ex, NULL };
                    164: static v_pre   pres_fd[] = { pre_fd, NULL };
                    165: static v_pre   pres_it[] = { pre_it, NULL };
                    166: static v_pre   pres_lb[] = { pre_lb, NULL };
1.12      kristaps  167: static v_pre   pres_os[] = { pre_os, NULL };
1.1       kristaps  168: static v_pre   pres_rv[] = { pre_rv, NULL };
                    169: static v_pre   pres_sh[] = { pre_sh, NULL };
                    170: static v_pre   pres_ss[] = { pre_ss, NULL };
                    171: static v_post  posts_bool[] = { eerr_eq1, ebool, NULL };
                    172: static v_post  posts_bd[] = { herr_eq0, bwarn_ge1, NULL };
                    173: static v_post  posts_text[] = { eerr_ge1, NULL };
                    174: static v_post  posts_wtext[] = { ewarn_ge1, NULL };
                    175: static v_post  posts_notext[] = { eerr_eq0, NULL };
                    176: static v_post  posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
                    177: static v_post  posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
1.14      kristaps  178: static v_post  posts_bl[] = { bwarn_ge1, post_bl, NULL };
1.1       kristaps  179: static v_post  posts_it[] = { post_it, NULL };
                    180: static v_post  posts_in[] = { ewarn_eq1, NULL };
                    181: static v_post  posts_ss[] = { herr_ge1, NULL };
                    182: static v_post  posts_pf[] = { eerr_eq1, NULL };
                    183: static v_post  posts_lb[] = { eerr_eq1, NULL };
                    184: static v_post  posts_st[] = { eerr_eq1, post_st, NULL };
                    185: static v_post  posts_pp[] = { ewarn_eq0, NULL };
                    186: static v_post  posts_ex[] = { eerr_eq0, post_args, NULL };
                    187: static v_post  posts_rv[] = { eerr_eq0, post_args, NULL };
                    188: static v_post  posts_an[] = { post_an, NULL };
                    189: static v_post  posts_at[] = { post_at, NULL };
                    190: static v_post  posts_xr[] = { eerr_ge1, eerr_le2, NULL };
                    191: static v_post  posts_nm[] = { post_nm, NULL };
                    192: static v_post  posts_bf[] = { hwarn_le1, post_bf, NULL };
                    193: static v_post  posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
                    194:
                    195: const  struct valids mdoc_valids[MDOC_MAX] = {
1.10      kristaps  196:        { NULL, NULL },                         /* Ap */
1.1       kristaps  197:        { pres_dd, posts_text },                /* Dd */
                    198:        { pres_dt, NULL },                      /* Dt */
                    199:        { pres_os, NULL },                      /* Os */
                    200:        { pres_sh, posts_sh },                  /* Sh */
                    201:        { pres_ss, posts_ss },                  /* Ss */
                    202:        { NULL, posts_pp },                     /* Pp */
                    203:        { pres_d1, posts_wline },               /* D1 */
                    204:        { pres_d1, posts_wline },               /* Dl */
                    205:        { pres_bd, posts_bd },                  /* Bd */
                    206:        { NULL, NULL },                         /* Ed */
                    207:        { pres_bl, posts_bl },                  /* Bl */
                    208:        { NULL, NULL },                         /* El */
                    209:        { pres_it, posts_it },                  /* It */
                    210:        { NULL, posts_text },                   /* Ad */
                    211:        { pres_an, posts_an },                  /* An */
                    212:        { NULL, NULL },                         /* Ar */
                    213:        { pres_cd, posts_text },                /* Cd */
                    214:        { NULL, NULL },                         /* Cm */
                    215:        { NULL, NULL },                         /* Dv */
                    216:        { pres_er, posts_text },                /* Er */
                    217:        { NULL, NULL },                         /* Ev */
                    218:        { pres_ex, posts_ex },                  /* Ex */
                    219:        { NULL, NULL },                         /* Fa */
                    220:        { pres_fd, posts_wtext },               /* Fd */
                    221:        { NULL, NULL },                         /* Fl */
                    222:        { NULL, posts_text },                   /* Fn */
                    223:        { NULL, posts_wtext },                  /* Ft */
                    224:        { NULL, posts_text },                   /* Ic */
                    225:        { NULL, posts_in },                     /* In */
                    226:        { NULL, NULL },                         /* Li */
                    227:        { NULL, posts_wtext },                  /* Nd */
                    228:        { NULL, posts_nm },                     /* Nm */
                    229:        { NULL, posts_wline },                  /* Op */
                    230:        { NULL, NULL },                         /* Ot */
                    231:        { NULL, NULL },                         /* Pa */
                    232:        { pres_rv, posts_rv },                  /* Rv */
                    233:        { NULL, posts_st },                     /* St */
                    234:        { NULL, NULL },                         /* Va */
                    235:        { NULL, posts_text },                   /* Vt */
                    236:        { NULL, posts_xr },                     /* Xr */
                    237:        { NULL, posts_text },                   /* %A */
                    238:        { NULL, posts_text },                   /* %B */
                    239:        { NULL, posts_text },                   /* %D */
                    240:        { NULL, posts_text },                   /* %I */
                    241:        { NULL, posts_text },                   /* %J */
                    242:        { NULL, posts_text },                   /* %N */
                    243:        { NULL, posts_text },                   /* %O */
                    244:        { NULL, posts_text },                   /* %P */
                    245:        { NULL, posts_text },                   /* %R */
                    246:        { NULL, posts_text },                   /* %T */
                    247:        { NULL, posts_text },                   /* %V */
                    248:        { NULL, NULL },                         /* Ac */
                    249:        { NULL, NULL },                         /* Ao */
                    250:        { NULL, posts_wline },                  /* Aq */
                    251:        { NULL, posts_at },                     /* At */
                    252:        { NULL, NULL },                         /* Bc */
                    253:        { NULL, posts_bf },                     /* Bf */
                    254:        { NULL, NULL },                         /* Bo */
                    255:        { NULL, posts_wline },                  /* Bq */
                    256:        { NULL, NULL },                         /* Bsx */
                    257:        { NULL, NULL },                         /* Bx */
                    258:        { NULL, posts_bool },                   /* Db */
                    259:        { NULL, NULL },                         /* Dc */
                    260:        { NULL, NULL },                         /* Do */
                    261:        { NULL, posts_wline },                  /* Dq */
                    262:        { NULL, NULL },                         /* Ec */
                    263:        { NULL, NULL },                         /* Ef */
                    264:        { NULL, NULL },                         /* Em */
                    265:        { NULL, NULL },                         /* Eo */
                    266:        { NULL, NULL },                         /* Fx */
                    267:        { NULL, posts_text },                   /* Ms */
                    268:        { NULL, posts_notext },                 /* No */
                    269:        { NULL, posts_notext },                 /* Ns */
                    270:        { NULL, NULL },                         /* Nx */
                    271:        { NULL, NULL },                         /* Ox */
                    272:        { NULL, NULL },                         /* Pc */
                    273:        { NULL, posts_pf },                     /* Pf */
                    274:        { NULL, NULL },                         /* Po */
                    275:        { NULL, posts_wline },                  /* Pq */
                    276:        { NULL, NULL },                         /* Qc */
                    277:        { NULL, posts_wline },                  /* Ql */
                    278:        { NULL, NULL },                         /* Qo */
                    279:        { NULL, posts_wline },                  /* Qq */
                    280:        { NULL, NULL },                         /* Re */
                    281:        { NULL, posts_wline },                  /* Rs */
                    282:        { NULL, NULL },                         /* Sc */
                    283:        { NULL, NULL },                         /* So */
                    284:        { NULL, posts_wline },                  /* Sq */
                    285:        { NULL, posts_bool },                   /* Sm */
                    286:        { NULL, posts_text },                   /* Sx */
                    287:        { NULL, posts_text },                   /* Sy */
                    288:        { NULL, posts_text },                   /* Tn */
                    289:        { NULL, NULL },                         /* Ux */
                    290:        { NULL, NULL },                         /* Xc */
                    291:        { NULL, NULL },                         /* Xo */
                    292:        { NULL, posts_fo },                     /* Fo */
                    293:        { NULL, NULL },                         /* Fc */
                    294:        { NULL, NULL },                         /* Oo */
                    295:        { NULL, NULL },                         /* Oc */
                    296:        { NULL, posts_wline },                  /* Bk */
                    297:        { NULL, NULL },                         /* Ek */
                    298:        { NULL, posts_notext },                 /* Bt */
                    299:        { NULL, NULL },                         /* Hf */
                    300:        { NULL, NULL },                         /* Fr */
                    301:        { NULL, posts_notext },                 /* Ud */
                    302:        { pres_lb, posts_lb },                  /* Lb */
                    303:        { NULL, posts_pp },                     /* Lp */
1.9       kristaps  304:        { NULL, NULL },                         /* Lk */
1.1       kristaps  305:        { NULL, posts_text },                   /* Mt */
                    306:        { NULL, posts_wline },                  /* Brq */
                    307:        { NULL, NULL },                         /* Bro */
                    308:        { NULL, NULL },                         /* Brc */
                    309:        { NULL, posts_text },                   /* %C */
                    310:        { NULL, NULL },                         /* Es */
                    311:        { NULL, NULL },                         /* En */
                    312:        { NULL, NULL },                         /* Dx */
                    313:        { NULL, posts_text },                   /* %Q */
                    314: };
                    315:
                    316:
1.2       kristaps  317: #ifdef __linux__
                    318: extern size_t  strlcat(char *, const char *, size_t);
                    319: #endif
                    320:
                    321:
1.1       kristaps  322: int
                    323: mdoc_valid_pre(struct mdoc *mdoc,
                    324:                const struct mdoc_node *n)
                    325: {
                    326:        v_pre           *p;
                    327:        int              line, pos;
                    328:        const char      *tp;
                    329:
                    330:        if (MDOC_TEXT == n->type) {
                    331:                tp = n->string;
                    332:                line = n->line;
                    333:                pos = n->pos;
                    334:                return(check_text(mdoc, line, pos, tp));
                    335:        }
                    336:
                    337:        if ( ! check_args(mdoc, n))
                    338:                return(0);
                    339:        if (NULL == mdoc_valids[n->tok].pre)
                    340:                return(1);
                    341:        for (p = mdoc_valids[n->tok].pre; *p; p++)
                    342:                if ( ! (*p)(mdoc, n))
                    343:                        return(0);
                    344:        return(1);
                    345: }
                    346:
                    347:
                    348: int
                    349: mdoc_valid_post(struct mdoc *mdoc)
                    350: {
                    351:        v_post          *p;
                    352:
                    353:        /*
                    354:         * This check occurs after the macro's children have been filled
                    355:         * in: postfix validation.  Since this happens when we're
                    356:         * rewinding the scope tree, it's possible to have multiple
                    357:         * invocations (as by design, for now), we set bit MDOC_VALID to
                    358:         * indicate that we've validated.
                    359:         */
                    360:
                    361:        if (MDOC_VALID & mdoc->last->flags)
                    362:                return(1);
                    363:        mdoc->last->flags |= MDOC_VALID;
                    364:
                    365:        if (MDOC_TEXT == mdoc->last->type)
                    366:                return(1);
                    367:        if (MDOC_ROOT == mdoc->last->type)
                    368:                return(post_root(mdoc));
                    369:
                    370:        if (NULL == mdoc_valids[mdoc->last->tok].post)
                    371:                return(1);
                    372:        for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
                    373:                if ( ! (*p)(mdoc))
                    374:                        return(0);
                    375:
                    376:        return(1);
                    377: }
                    378:
                    379:
                    380: static int
                    381: perr(struct mdoc *m, int line, int pos, enum merr type)
                    382: {
                    383:        char             *p;
                    384:
                    385:        p = NULL;
                    386:        switch (type) {
1.2       kristaps  387:        case (ETOOLONG):
                    388:                p = "text argument too long";
                    389:                break;
1.1       kristaps  390:        case (EESCAPE):
                    391:                p = "invalid escape sequence";
                    392:                break;
                    393:        case (EPRINT):
                    394:                p = "invalid character";
                    395:                break;
                    396:        case (ENESTDISP):
                    397:                p = "displays may not be nested";
                    398:                break;
                    399:        case (EBOOL):
                    400:                p = "expected boolean value";
                    401:                break;
                    402:        case (EARGREP):
                    403:                p = "argument repeated";
                    404:                break;
                    405:        case (EMULTIDISP):
                    406:                p = "multiple display types specified";
                    407:                break;
                    408:        case (EMULTILIST):
                    409:                p = "multiple list types specified";
                    410:                break;
                    411:        case (ELISTTYPE):
                    412:                p = "missing list type";
                    413:                break;
                    414:        case (EDISPTYPE):
                    415:                p = "missing display type";
                    416:                break;
1.12      kristaps  417:        case (ESECNAME):
                    418:                p = "the NAME section must come first";
                    419:                break;
1.1       kristaps  420:        case (ELINE):
                    421:                p = "expected line arguments";
                    422:                break;
                    423:        case (ENOPROLOGUE):
                    424:                p = "document has no prologue";
                    425:                break;
                    426:        case (ENODATA):
                    427:                p = "document has no data";
                    428:                break;
1.14      kristaps  429:        case (ECOLMIS):
                    430:                p = "column syntax style mismatch";
                    431:                break;
1.1       kristaps  432:        case (EATT):
                    433:                p = "expected valid AT&T symbol";
                    434:                break;
                    435:        case (ENAME):
                    436:                p = "default name not yet set";
                    437:                break;
                    438:        }
                    439:        assert(p);
                    440:        return(mdoc_perr(m, line, pos, p));
                    441: }
                    442:
                    443:
                    444: static int
                    445: pwarn(struct mdoc *m, int line, int pos, enum mwarn type)
                    446: {
                    447:        char             *p;
                    448:        enum mdoc_warn    c;
                    449:
                    450:        c = WARN_SYNTAX;
                    451:        p = NULL;
                    452:        switch (type) {
                    453:        case (WBADMSEC):
                    454:                p = "inappropriate manual section";
                    455:                c = WARN_COMPAT;
                    456:                break;
                    457:        case (WBADSEC):
                    458:                p = "inappropriate document section";
                    459:                c = WARN_COMPAT;
                    460:                break;
                    461:        case (WARGVAL):
                    462:                p = "argument value suggested";
                    463:                c = WARN_COMPAT;
                    464:                break;
                    465:        case (WPROLREP):
                    466:                p = "prologue macros repeated";
                    467:                c = WARN_COMPAT;
                    468:                break;
                    469:        case (WPROLOOO):
                    470:                p = "prologue macros out-of-order";
                    471:                c = WARN_COMPAT;
                    472:                break;
1.8       kristaps  473:        case (WDEPCOL):
                    474:                p = "deprecated column argument syntax";
                    475:                c = WARN_COMPAT;
                    476:                break;
                    477:        case (WNOWIDTH):
                    478:                p = "superfluous width argument";
                    479:                break;
                    480:        case (WMISSWIDTH):
                    481:                p = "missing width argument";
                    482:                break;
1.4       kristaps  483:        case (WPRINT):
                    484:                p = "invalid character";
                    485:                break;
1.1       kristaps  486:        case (WESCAPE):
                    487:                p = "invalid escape sequence";
                    488:                break;
                    489:        case (WNOLINE):
                    490:                p = "suggested no line arguments";
                    491:                break;
                    492:        case (WLINE):
                    493:                p = "suggested line arguments";
                    494:                break;
                    495:        case (WMULTILINE):
                    496:                p = "suggested multi-line arguments";
                    497:                break;
                    498:        case (WNOMULTILINE):
                    499:                p = "suggested no multi-line arguments";
                    500:                break;
                    501:        case (WWRONGMSEC):
                    502:                p = "document section in wrong manual section";
                    503:                c = WARN_COMPAT;
                    504:                break;
                    505:        case (WSECOOO):
                    506:                p = "document section out of conventional order";
                    507:                break;
                    508:        case (WSECREP):
                    509:                p = "document section repeated";
                    510:                break;
                    511:        case (WBADSTAND):
                    512:                p = "unknown standard";
                    513:                break;
                    514:        case (WNAMESECINC):
                    515:                p = "NAME section contents incomplete/badly-ordered";
                    516:                break;
                    517:        }
                    518:        assert(p);
                    519:        return(mdoc_pwarn(m, line, pos, c, p));
                    520: }
                    521:
                    522:
1.4       kristaps  523: static int
                    524: warn_print(struct mdoc *m, int ln, int pos)
                    525: {
                    526:        if (MDOC_IGN_CHARS & m->pflags)
                    527:                return(pwarn(m, ln, pos, WPRINT));
                    528:        return(perr(m, ln, pos, EPRINT));
                    529: }
                    530:
1.1       kristaps  531:
                    532: static inline int
                    533: warn_count(struct mdoc *m, const char *k,
                    534:                int want, const char *v, int has)
                    535: {
                    536:
                    537:        return(mdoc_warn(m, WARN_SYNTAX,
                    538:                "suggests %s %s %d (has %d)", v, k, want, has));
                    539: }
                    540:
                    541:
                    542: static inline int
                    543: err_count(struct mdoc *m, const char *k,
                    544:                int want, const char *v, int has)
                    545: {
                    546:
                    547:        return(mdoc_err(m,
                    548:                "requires %s %s %d (has %d)", v, k, want, has));
                    549: }
                    550:
                    551:
                    552: /*
                    553:  * Build these up with macros because they're basically the same check
                    554:  * for different inequalities.  Yes, this could be done with functions,
                    555:  * but this is reasonable for now.
                    556:  */
                    557:
                    558: #define CHECK_CHILD_DEFN(lvl, name, ineq)                      \
                    559: static int                                                     \
                    560: lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz)   \
                    561: {                                                              \
1.16      kristaps  562:        if (mdoc->last->nchild ineq sz)                         \
1.1       kristaps  563:                return(1);                                      \
1.16      kristaps  564:        return(lvl##_count(mdoc, #ineq, sz, p, mdoc->last->nchild)); \
1.1       kristaps  565: }
                    566:
                    567: #define CHECK_BODY_DEFN(name, lvl, func, num)                  \
                    568: static int                                                     \
                    569: b##lvl##_##name(POST_ARGS)                                     \
                    570: {                                                              \
                    571:        if (MDOC_BODY != mdoc->last->type)                      \
                    572:                return(1);                                      \
                    573:        return(func(mdoc, "multi-line arguments", (num)));      \
                    574: }
                    575:
                    576: #define CHECK_ELEM_DEFN(name, lvl, func, num)                  \
                    577: static int                                                     \
                    578: e##lvl##_##name(POST_ARGS)                                     \
                    579: {                                                              \
                    580:        assert(MDOC_ELEM == mdoc->last->type);                  \
                    581:        return(func(mdoc, "line arguments", (num)));            \
                    582: }
                    583:
                    584: #define CHECK_HEAD_DEFN(name, lvl, func, num)                  \
                    585: static int                                                     \
                    586: h##lvl##_##name(POST_ARGS)                                     \
                    587: {                                                              \
                    588:        if (MDOC_HEAD != mdoc->last->type)                      \
                    589:                return(1);                                      \
                    590:        return(func(mdoc, "line arguments", (num)));            \
                    591: }
                    592:
                    593:
                    594: CHECK_CHILD_DEFN(warn, gt, >)                  /* warn_child_gt() */
                    595: CHECK_CHILD_DEFN(err, gt, >)                   /* err_child_gt() */
                    596: CHECK_CHILD_DEFN(warn, eq, ==)                 /* warn_child_eq() */
                    597: CHECK_CHILD_DEFN(err, eq, ==)                  /* err_child_eq() */
                    598: CHECK_CHILD_DEFN(err, lt, <)                   /* err_child_lt() */
                    599: CHECK_CHILD_DEFN(warn, lt, <)                  /* warn_child_lt() */
                    600: CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0)   /* bwarn_ge1() */
                    601: CHECK_ELEM_DEFN(eq1, warn, warn_child_eq, 1)   /* ewarn_eq1() */
                    602: CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0)   /* ewarn_eq0() */
                    603: CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0)   /* ewarn_gt1() */
                    604: CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1)     /* eerr_eq1() */
                    605: CHECK_ELEM_DEFN(le2, err, err_child_lt, 3)     /* eerr_le2() */
                    606: CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0)     /* eerr_eq0() */
                    607: CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0)     /* eerr_ge1() */
                    608: CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0)     /* herr_eq0() */
                    609: CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2)   /* hwarn_le1() */
                    610: CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0)     /* herr_ge1() */
                    611: CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1)   /* hwarn_eq1() */
                    612:
                    613:
                    614: static int
                    615: check_stdarg(PRE_ARGS)
                    616: {
                    617:
                    618:        if (n->args && 1 == n->args->argc)
                    619:                if (MDOC_Std == n->args->argv[0].arg)
                    620:                        return(1);
                    621:        return(nwarn(mdoc, n, WARGVAL));
                    622: }
                    623:
                    624:
                    625: static int
                    626: check_sec(PRE_ARGS, ...)
                    627: {
                    628:        enum mdoc_sec    sec;
                    629:        va_list          ap;
                    630:
                    631:        va_start(ap, n);
                    632:
                    633:        for (;;) {
                    634:                /* LINTED */
                    635:                sec = (enum mdoc_sec)va_arg(ap, int);
                    636:                if (SEC_CUSTOM == sec)
                    637:                        break;
                    638:                if (sec != mdoc->lastsec)
                    639:                        continue;
                    640:                va_end(ap);
                    641:                return(1);
                    642:        }
                    643:
                    644:        va_end(ap);
                    645:        return(nwarn(mdoc, n, WBADSEC));
                    646: }
                    647:
                    648:
                    649: static int
                    650: check_msec(PRE_ARGS, ...)
                    651: {
                    652:        va_list          ap;
                    653:        int              msec;
                    654:
                    655:        va_start(ap, n);
                    656:        for (;;) {
                    657:                /* LINTED */
                    658:                if (0 == (msec = va_arg(ap, int)))
                    659:                        break;
                    660:                if (msec != mdoc->meta.msec)
                    661:                        continue;
                    662:                va_end(ap);
                    663:                return(1);
                    664:        }
                    665:
                    666:        va_end(ap);
                    667:        return(nwarn(mdoc, n, WBADMSEC));
                    668: }
                    669:
                    670:
                    671: static int
                    672: check_args(struct mdoc *m, const struct mdoc_node *n)
                    673: {
                    674:        int              i;
                    675:
                    676:        if (NULL == n->args)
                    677:                return(1);
                    678:
                    679:        assert(n->args->argc);
                    680:        for (i = 0; i < (int)n->args->argc; i++)
                    681:                if ( ! check_argv(m, n, &n->args->argv[i]))
                    682:                        return(0);
                    683:
                    684:        return(1);
                    685: }
                    686:
                    687:
                    688: static int
                    689: check_argv(struct mdoc *m, const struct mdoc_node *n,
                    690:                const struct mdoc_argv *v)
                    691: {
                    692:        int              i;
                    693:
                    694:        for (i = 0; i < (int)v->sz; i++)
                    695:                if ( ! check_text(m, v->line, v->pos, v->value[i]))
                    696:                        return(0);
                    697:
                    698:        if (MDOC_Std == v->arg) {
                    699:                /* `Nm' name must be set. */
                    700:                if (v->sz || m->meta.name)
                    701:                        return(1);
                    702:                return(nerr(m, n, ENAME));
                    703:        }
                    704:
                    705:        return(1);
                    706: }
                    707:
                    708:
                    709: static int
                    710: check_text(struct mdoc *mdoc, int line, int pos, const char *p)
                    711: {
1.18    ! kristaps  712:        int              c;
1.1       kristaps  713:
1.18    ! kristaps  714:        for ( ; *p; p++, pos++) {
1.1       kristaps  715:                if ('\t' == *p) {
                    716:                        if ( ! (MDOC_LITERAL & mdoc->flags))
1.4       kristaps  717:                                if ( ! warn_print(mdoc, line, pos))
                    718:                                        return(0);
1.1       kristaps  719:                } else if ( ! isprint((u_char)*p))
1.4       kristaps  720:                        if ( ! warn_print(mdoc, line, pos))
                    721:                                return(0);
1.1       kristaps  722:
                    723:                if ('\\' != *p)
                    724:                        continue;
                    725:
1.18    ! kristaps  726:                c = mandoc_special(p);
1.1       kristaps  727:                if (c) {
1.18    ! kristaps  728:                        p += c - 1;
        !           729:                        pos += c - 1;
1.1       kristaps  730:                        continue;
                    731:                }
                    732:                if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags))
                    733:                        return(perr(mdoc, line, pos, EESCAPE));
                    734:                if ( ! pwarn(mdoc, line, pos, WESCAPE))
                    735:                        return(0);
                    736:        }
                    737:
                    738:        return(1);
                    739: }
                    740:
                    741:
                    742:
                    743:
                    744: static int
                    745: check_parent(PRE_ARGS, int tok, enum mdoc_type t)
                    746: {
                    747:
                    748:        assert(n->parent);
                    749:        if ((MDOC_ROOT == t || tok == n->parent->tok) &&
                    750:                        (t == n->parent->type))
                    751:                return(1);
                    752:
                    753:        return(mdoc_nerr(mdoc, n, "require parent %s",
                    754:                MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]));
                    755: }
                    756:
                    757:
                    758:
                    759: static int
                    760: pre_display(PRE_ARGS)
                    761: {
                    762:        struct mdoc_node *node;
                    763:
                    764:        /* Display elements (`Bd', `D1'...) cannot be nested. */
                    765:
                    766:        if (MDOC_BLOCK != n->type)
                    767:                return(1);
                    768:
                    769:        /* LINTED */
                    770:        for (node = mdoc->last->parent; node; node = node->parent)
                    771:                if (MDOC_BLOCK == node->type)
                    772:                        if (MDOC_Bd == node->tok)
                    773:                                break;
                    774:        if (NULL == node)
                    775:                return(1);
                    776:
                    777:        return(nerr(mdoc, n, ENESTDISP));
                    778: }
                    779:
                    780:
                    781: static int
                    782: pre_bl(PRE_ARGS)
                    783: {
1.15      kristaps  784:        int              pos, type, width, offset;
1.1       kristaps  785:
                    786:        if (MDOC_BLOCK != n->type)
                    787:                return(1);
                    788:        if (NULL == n->args)
                    789:                return(nerr(mdoc, n, ELISTTYPE));
                    790:
                    791:        /* Make sure that only one type of list is specified.  */
                    792:
1.15      kristaps  793:        type = offset = width = -1;
1.1       kristaps  794:
                    795:        /* LINTED */
1.8       kristaps  796:        for (pos = 0; pos < (int)n->args->argc; pos++)
                    797:                switch (n->args->argv[pos].arg) {
1.1       kristaps  798:                case (MDOC_Bullet):
                    799:                        /* FALLTHROUGH */
                    800:                case (MDOC_Dash):
                    801:                        /* FALLTHROUGH */
                    802:                case (MDOC_Enum):
                    803:                        /* FALLTHROUGH */
                    804:                case (MDOC_Hyphen):
                    805:                        /* FALLTHROUGH */
                    806:                case (MDOC_Item):
                    807:                        /* FALLTHROUGH */
                    808:                case (MDOC_Tag):
                    809:                        /* FALLTHROUGH */
                    810:                case (MDOC_Diag):
                    811:                        /* FALLTHROUGH */
                    812:                case (MDOC_Hang):
                    813:                        /* FALLTHROUGH */
                    814:                case (MDOC_Ohang):
                    815:                        /* FALLTHROUGH */
                    816:                case (MDOC_Inset):
                    817:                        /* FALLTHROUGH */
                    818:                case (MDOC_Column):
1.8       kristaps  819:                        if (-1 != type)
                    820:                                return(nerr(mdoc, n, EMULTILIST));
                    821:                        type = n->args->argv[pos].arg;
                    822:                        break;
1.1       kristaps  823:                case (MDOC_Width):
1.8       kristaps  824:                        if (-1 != width)
                    825:                                return(nerr(mdoc, n, EARGREP));
                    826:                        width = n->args->argv[pos].arg;
                    827:                        break;
1.1       kristaps  828:                case (MDOC_Offset):
1.8       kristaps  829:                        if (-1 != offset)
                    830:                                return(nerr(mdoc, n, EARGREP));
                    831:                        offset = n->args->argv[pos].arg;
                    832:                        break;
1.1       kristaps  833:                default:
                    834:                        break;
                    835:                }
                    836:
                    837:        if (-1 == type)
                    838:                return(nerr(mdoc, n, ELISTTYPE));
                    839:
1.8       kristaps  840:        /*
                    841:         * Validate the width field.  Some list types don't need width
                    842:         * types and should be warned about them.  Others should have it
                    843:         * and must also be warned.
                    844:         */
                    845:
1.1       kristaps  846:        switch (type) {
1.8       kristaps  847:        case (MDOC_Tag):
                    848:                if (-1 == width && ! nwarn(mdoc, n, WMISSWIDTH))
                    849:                        return(0);
                    850:                break;
1.1       kristaps  851:        case (MDOC_Column):
                    852:                /* FALLTHROUGH */
                    853:        case (MDOC_Diag):
                    854:                /* FALLTHROUGH */
                    855:        case (MDOC_Inset):
                    856:                /* FALLTHROUGH */
                    857:        case (MDOC_Item):
1.8       kristaps  858:                if (-1 != width && ! nwarn(mdoc, n, WNOWIDTH))
                    859:                        return(0);
                    860:                break;
                    861:        default:
                    862:                break;
                    863:        }
                    864:
1.1       kristaps  865:        return(1);
                    866: }
                    867:
                    868:
                    869: static int
                    870: pre_bd(PRE_ARGS)
                    871: {
                    872:        int              i, type, err;
                    873:
                    874:        if (MDOC_BLOCK != n->type)
                    875:                return(1);
                    876:        if (NULL == n->args)
                    877:                return(nerr(mdoc, n, EDISPTYPE));
                    878:
                    879:        /* Make sure that only one type of display is specified.  */
                    880:
                    881:        /* LINTED */
                    882:        for (i = 0, err = type = 0; ! err &&
                    883:                        i < (int)n->args->argc; i++)
                    884:                switch (n->args->argv[i].arg) {
                    885:                case (MDOC_Ragged):
                    886:                        /* FALLTHROUGH */
                    887:                case (MDOC_Unfilled):
                    888:                        /* FALLTHROUGH */
                    889:                case (MDOC_Filled):
                    890:                        /* FALLTHROUGH */
                    891:                case (MDOC_Literal):
                    892:                        /* FALLTHROUGH */
                    893:                case (MDOC_File):
                    894:                        if (0 == type++)
                    895:                                break;
                    896:                        return(nerr(mdoc, n, EMULTIDISP));
                    897:                default:
                    898:                        break;
                    899:                }
                    900:
                    901:        if (type)
                    902:                return(1);
                    903:        return(nerr(mdoc, n, EDISPTYPE));
                    904: }
                    905:
                    906:
                    907: static int
                    908: pre_ss(PRE_ARGS)
                    909: {
                    910:
                    911:        if (MDOC_BLOCK != n->type)
                    912:                return(1);
                    913:        return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
                    914: }
                    915:
                    916:
                    917: static int
                    918: pre_sh(PRE_ARGS)
                    919: {
                    920:
                    921:        if (MDOC_BLOCK != n->type)
                    922:                return(1);
                    923:        return(check_parent(mdoc, n, -1, MDOC_ROOT));
                    924: }
                    925:
                    926:
                    927: static int
                    928: pre_it(PRE_ARGS)
                    929: {
                    930:
                    931:        if (MDOC_BLOCK != n->type)
                    932:                return(1);
                    933:        return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
                    934: }
                    935:
                    936:
                    937: static int
                    938: pre_an(PRE_ARGS)
                    939: {
                    940:
                    941:        if (NULL == n->args || 1 == n->args->argc)
                    942:                return(1);
                    943:        return(mdoc_nerr(mdoc, n, "only one argument allowed"));
                    944: }
                    945:
                    946:
                    947: static int
                    948: pre_lb(PRE_ARGS)
                    949: {
                    950:
                    951:        return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM));
                    952: }
                    953:
                    954:
                    955: static int
                    956: pre_rv(PRE_ARGS)
                    957: {
                    958:
                    959:        if ( ! check_msec(mdoc, n, 2, 3, 0))
                    960:                return(0);
                    961:        return(check_stdarg(mdoc, n));
                    962: }
                    963:
                    964:
                    965: static int
                    966: pre_ex(PRE_ARGS)
                    967: {
                    968:
                    969:        if ( ! check_msec(mdoc, n, 1, 6, 8, 0))
                    970:                return(0);
                    971:        return(check_stdarg(mdoc, n));
                    972: }
                    973:
                    974:
                    975: static int
                    976: pre_er(PRE_ARGS)
                    977: {
                    978:
1.6       kristaps  979:        return(check_msec(mdoc, n, 2, 3, 9, 0));
1.1       kristaps  980: }
                    981:
                    982:
                    983: static int
                    984: pre_cd(PRE_ARGS)
                    985: {
                    986:
                    987:        return(check_msec(mdoc, n, 4, 0));
                    988: }
                    989:
                    990:
                    991: static int
                    992: pre_dt(PRE_ARGS)
                    993: {
                    994:
                    995:        if (0 == mdoc->meta.date || mdoc->meta.os)
                    996:                if ( ! nwarn(mdoc, n, WPROLOOO))
                    997:                        return(0);
                    998:        if (mdoc->meta.title)
                    999:                if ( ! nwarn(mdoc, n, WPROLREP))
                   1000:                        return(0);
                   1001:        return(1);
                   1002: }
                   1003:
                   1004:
                   1005: static int
                   1006: pre_os(PRE_ARGS)
                   1007: {
                   1008:
                   1009:        if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
                   1010:                if ( ! nwarn(mdoc, n, WPROLOOO))
                   1011:                        return(0);
                   1012:        if (mdoc->meta.os)
                   1013:                if ( ! nwarn(mdoc, n, WPROLREP))
                   1014:                        return(0);
                   1015:        return(1);
                   1016: }
                   1017:
                   1018:
                   1019: static int
                   1020: pre_dd(PRE_ARGS)
                   1021: {
                   1022:
                   1023:        if (mdoc->meta.title || mdoc->meta.os)
                   1024:                if ( ! nwarn(mdoc, n, WPROLOOO))
                   1025:                        return(0);
                   1026:        if (mdoc->meta.date)
                   1027:                if ( ! nwarn(mdoc, n, WPROLREP))
                   1028:                        return(0);
                   1029:        return(1);
                   1030: }
                   1031:
                   1032:
                   1033: static int
                   1034: post_bf(POST_ARGS)
                   1035: {
                   1036:        char             *p;
                   1037:        struct mdoc_node *head;
                   1038:
                   1039:        if (MDOC_BLOCK != mdoc->last->type)
                   1040:                return(1);
                   1041:
                   1042:        head = mdoc->last->head;
                   1043:
1.12      kristaps 1044:        if (mdoc->last->args && head->child)
1.13      kristaps 1045:                return(mdoc_err(mdoc, "one argument expected"));
                   1046:        else if (mdoc->last->args)
                   1047:                return(1);
1.12      kristaps 1048:
1.13      kristaps 1049:        if (NULL == head->child || MDOC_TEXT != head->child->type)
                   1050:                return(mdoc_err(mdoc, "text argument expected"));
1.1       kristaps 1051:
1.13      kristaps 1052:        p = head->child->string;
1.1       kristaps 1053:
1.13      kristaps 1054:        if (0 == strcmp(p, "Em"))
                   1055:                return(1);
                   1056:        else if (0 == strcmp(p, "Li"))
                   1057:                return(1);
                   1058:        else if (0 == strcmp(p, "Sm"))
                   1059:                return(1);
1.1       kristaps 1060:
1.13      kristaps 1061:        return(mdoc_nerr(mdoc, head->child, "invalid font mode"));
1.1       kristaps 1062: }
                   1063:
                   1064:
                   1065: static int
                   1066: post_nm(POST_ARGS)
                   1067: {
                   1068:
                   1069:        if (mdoc->last->child)
                   1070:                return(1);
                   1071:        if (mdoc->meta.name)
                   1072:                return(1);
1.2       kristaps 1073:        return(verr(mdoc, ENAME));
1.1       kristaps 1074: }
                   1075:
                   1076:
                   1077: static int
                   1078: post_at(POST_ARGS)
                   1079: {
                   1080:
                   1081:        if (NULL == mdoc->last->child)
                   1082:                return(1);
                   1083:        if (MDOC_TEXT != mdoc->last->child->type)
1.2       kristaps 1084:                return(verr(mdoc, EATT));
1.1       kristaps 1085:        if (mdoc_a2att(mdoc->last->child->string))
                   1086:                return(1);
1.2       kristaps 1087:        return(verr(mdoc, EATT));
1.1       kristaps 1088: }
                   1089:
                   1090:
                   1091: static int
                   1092: post_an(POST_ARGS)
                   1093: {
                   1094:
                   1095:        if (mdoc->last->args) {
                   1096:                if (NULL == mdoc->last->child)
                   1097:                        return(1);
1.2       kristaps 1098:                return(verr(mdoc, ELINE));
1.1       kristaps 1099:        }
                   1100:
                   1101:        if (mdoc->last->child)
                   1102:                return(1);
1.2       kristaps 1103:        return(verr(mdoc, ELINE));
1.1       kristaps 1104: }
                   1105:
                   1106:
                   1107: static int
                   1108: post_args(POST_ARGS)
                   1109: {
                   1110:
                   1111:        if (mdoc->last->args)
                   1112:                return(1);
1.2       kristaps 1113:        return(verr(mdoc, ELINE));
1.1       kristaps 1114: }
                   1115:
                   1116:
                   1117: static int
                   1118: post_it(POST_ARGS)
                   1119: {
                   1120:        int               type, i, cols;
                   1121:        struct mdoc_node *n, *c;
                   1122:
                   1123:        if (MDOC_BLOCK != mdoc->last->type)
                   1124:                return(1);
                   1125:
                   1126:        n = mdoc->last->parent->parent;
                   1127:        if (NULL == n->args)
1.2       kristaps 1128:                return(verr(mdoc, ELISTTYPE));
1.1       kristaps 1129:
                   1130:        /* Some types require block-head, some not. */
                   1131:
                   1132:        /* LINTED */
                   1133:        for (cols = type = -1, i = 0; -1 == type &&
                   1134:                        i < (int)n->args->argc; i++)
                   1135:                switch (n->args->argv[i].arg) {
                   1136:                case (MDOC_Tag):
                   1137:                        /* FALLTHROUGH */
                   1138:                case (MDOC_Diag):
                   1139:                        /* FALLTHROUGH */
                   1140:                case (MDOC_Hang):
                   1141:                        /* FALLTHROUGH */
                   1142:                case (MDOC_Ohang):
                   1143:                        /* FALLTHROUGH */
                   1144:                case (MDOC_Inset):
                   1145:                        /* FALLTHROUGH */
                   1146:                case (MDOC_Bullet):
                   1147:                        /* FALLTHROUGH */
                   1148:                case (MDOC_Dash):
                   1149:                        /* FALLTHROUGH */
                   1150:                case (MDOC_Enum):
                   1151:                        /* FALLTHROUGH */
                   1152:                case (MDOC_Hyphen):
                   1153:                        /* FALLTHROUGH */
                   1154:                case (MDOC_Item):
                   1155:                        type = n->args->argv[i].arg;
                   1156:                        break;
                   1157:                case (MDOC_Column):
                   1158:                        type = n->args->argv[i].arg;
                   1159:                        cols = (int)n->args->argv[i].sz;
                   1160:                        break;
                   1161:                default:
                   1162:                        break;
                   1163:                }
                   1164:
                   1165:        if (-1 == type)
1.2       kristaps 1166:                return(verr(mdoc, ELISTTYPE));
1.1       kristaps 1167:
                   1168:        switch (type) {
                   1169:        case (MDOC_Tag):
                   1170:                if (NULL == mdoc->last->head->child)
1.2       kristaps 1171:                        if ( ! vwarn(mdoc, WLINE))
1.1       kristaps 1172:                                return(0);
                   1173:                break;
                   1174:        case (MDOC_Hang):
                   1175:                /* FALLTHROUGH */
                   1176:        case (MDOC_Ohang):
                   1177:                /* FALLTHROUGH */
                   1178:        case (MDOC_Inset):
                   1179:                /* FALLTHROUGH */
                   1180:        case (MDOC_Diag):
                   1181:                if (NULL == mdoc->last->head->child)
1.2       kristaps 1182:                        if ( ! vwarn(mdoc, WLINE))
1.1       kristaps 1183:                                return(0);
                   1184:                if (NULL == mdoc->last->body->child)
1.2       kristaps 1185:                        if ( ! vwarn(mdoc, WMULTILINE))
1.1       kristaps 1186:                                return(0);
                   1187:                break;
                   1188:        case (MDOC_Bullet):
                   1189:                /* FALLTHROUGH */
                   1190:        case (MDOC_Dash):
                   1191:                /* FALLTHROUGH */
                   1192:        case (MDOC_Enum):
                   1193:                /* FALLTHROUGH */
                   1194:        case (MDOC_Hyphen):
                   1195:                /* FALLTHROUGH */
                   1196:        case (MDOC_Item):
                   1197:                if (mdoc->last->head->child)
1.2       kristaps 1198:                        if ( ! vwarn(mdoc, WNOLINE))
1.1       kristaps 1199:                                return(0);
                   1200:                if (NULL == mdoc->last->body->child)
1.2       kristaps 1201:                        if ( ! vwarn(mdoc, WMULTILINE))
1.1       kristaps 1202:                                return(0);
                   1203:                break;
                   1204:        case (MDOC_Column):
                   1205:                if (NULL == mdoc->last->head->child)
1.2       kristaps 1206:                        if ( ! vwarn(mdoc, WLINE))
1.1       kristaps 1207:                                return(0);
                   1208:                if (mdoc->last->body->child)
1.2       kristaps 1209:                        if ( ! vwarn(mdoc, WNOMULTILINE))
1.1       kristaps 1210:                                return(0);
                   1211:                c = mdoc->last->child;
                   1212:                for (i = 0; c && MDOC_HEAD == c->type; c = c->next)
                   1213:                        i++;
                   1214:                if (i == cols)
                   1215:                        break;
                   1216:                return(mdoc_err(mdoc, "column mismatch (have "
                   1217:                                        "%d, want %d)", i, cols));
                   1218:        default:
                   1219:                break;
                   1220:        }
                   1221:
                   1222:        return(1);
                   1223: }
                   1224:
                   1225:
                   1226: static int
1.14      kristaps 1227: post_bl_head(POST_ARGS)
                   1228: {
                   1229:        int                     i;
                   1230:        const struct mdoc_node *n;
                   1231:
                   1232:        n = mdoc->last->parent;
                   1233:        assert(n->args);
                   1234:
                   1235:        for (i = 0; i < (int)n->args->argc; i++)
                   1236:                if (n->args->argv[i].arg == MDOC_Column)
                   1237:                        break;
                   1238:
                   1239:        if (i == (int)n->args->argc)
                   1240:                return(1);
                   1241:
                   1242:        if (n->args->argv[i].sz && mdoc->last->child)
                   1243:                return(nerr(mdoc, n, ECOLMIS));
                   1244:
                   1245:        return(1);
                   1246: }
                   1247:
                   1248:
                   1249: static int
1.1       kristaps 1250: post_bl(POST_ARGS)
                   1251: {
                   1252:        struct mdoc_node        *n;
                   1253:
1.14      kristaps 1254:        if (MDOC_HEAD == mdoc->last->type)
                   1255:                return(post_bl_head(mdoc));
1.1       kristaps 1256:        if (MDOC_BODY != mdoc->last->type)
                   1257:                return(1);
                   1258:        if (NULL == mdoc->last->child)
                   1259:                return(1);
                   1260:
                   1261:        /* LINTED */
                   1262:        for (n = mdoc->last->child; n; n = n->next) {
                   1263:                if (MDOC_BLOCK == n->type)
                   1264:                        if (MDOC_It == n->tok)
                   1265:                                continue;
                   1266:                return(mdoc_nerr(mdoc, n, "bad child of parent %s",
                   1267:                                mdoc_macronames[mdoc->last->tok]));
                   1268:        }
                   1269:
                   1270:        return(1);
                   1271: }
                   1272:
                   1273:
                   1274: static int
                   1275: ebool(struct mdoc *mdoc)
                   1276: {
                   1277:        struct mdoc_node *n;
                   1278:
                   1279:        /* LINTED */
                   1280:        for (n = mdoc->last->child; n; n = n->next) {
                   1281:                if (MDOC_TEXT != n->type)
                   1282:                        break;
1.2       kristaps 1283:                if (0 == strcmp(n->string, "on"))
1.1       kristaps 1284:                        continue;
1.2       kristaps 1285:                if (0 == strcmp(n->string, "off"))
1.1       kristaps 1286:                        continue;
                   1287:                break;
                   1288:        }
                   1289:
                   1290:        if (NULL == n)
                   1291:                return(1);
                   1292:        return(nerr(mdoc, n, EBOOL));
                   1293: }
                   1294:
                   1295:
                   1296: static int
                   1297: post_root(POST_ARGS)
                   1298: {
                   1299:
                   1300:        if (NULL == mdoc->first->child)
1.2       kristaps 1301:                return(verr(mdoc, ENODATA));
1.12      kristaps 1302:        if ( ! (MDOC_PBODY & mdoc->flags))
1.2       kristaps 1303:                return(verr(mdoc, ENOPROLOGUE));
1.1       kristaps 1304:
                   1305:        if (MDOC_BLOCK != mdoc->first->child->type)
1.2       kristaps 1306:                return(verr(mdoc, ENODATA));
1.1       kristaps 1307:        if (MDOC_Sh != mdoc->first->child->tok)
1.2       kristaps 1308:                return(verr(mdoc, ENODATA));
1.1       kristaps 1309:
                   1310:        return(1);
                   1311: }
                   1312:
                   1313:
                   1314: static int
                   1315: post_st(POST_ARGS)
                   1316: {
                   1317:
                   1318:        if (mdoc_a2st(mdoc->last->child->string))
                   1319:                return(1);
1.2       kristaps 1320:        return(vwarn(mdoc, WBADSTAND));
1.1       kristaps 1321: }
                   1322:
                   1323:
                   1324: static int
                   1325: post_sh(POST_ARGS)
                   1326: {
                   1327:
                   1328:        if (MDOC_HEAD == mdoc->last->type)
                   1329:                return(post_sh_head(mdoc));
                   1330:        if (MDOC_BODY == mdoc->last->type)
                   1331:                return(post_sh_body(mdoc));
                   1332:
                   1333:        return(1);
                   1334: }
                   1335:
                   1336:
                   1337: static int
                   1338: post_sh_body(POST_ARGS)
                   1339: {
                   1340:        struct mdoc_node *n;
                   1341:
                   1342:        if (SEC_NAME != mdoc->lastnamed)
                   1343:                return(1);
                   1344:
                   1345:        /*
                   1346:         * Warn if the NAME section doesn't contain the `Nm' and `Nd'
                   1347:         * macros (can have multiple `Nm' and one `Nd').  Note that the
                   1348:         * children of the BODY declaration can also be "text".
                   1349:         */
                   1350:
                   1351:        if (NULL == (n = mdoc->last->child))
1.2       kristaps 1352:                return(vwarn(mdoc, WNAMESECINC));
1.1       kristaps 1353:
                   1354:        for ( ; n && n->next; n = n->next) {
                   1355:                if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
                   1356:                        continue;
                   1357:                if (MDOC_TEXT == n->type)
                   1358:                        continue;
1.2       kristaps 1359:                if ( ! vwarn(mdoc, WNAMESECINC))
1.1       kristaps 1360:                        return(0);
                   1361:        }
                   1362:
                   1363:        if (MDOC_ELEM == n->type && MDOC_Nd == n->tok)
                   1364:                return(1);
1.2       kristaps 1365:        return(vwarn(mdoc, WNAMESECINC));
1.1       kristaps 1366: }
                   1367:
                   1368:
                   1369: static int
                   1370: post_sh_head(POST_ARGS)
                   1371: {
1.2       kristaps 1372:        char                    buf[64];
                   1373:        enum mdoc_sec           sec;
                   1374:        const struct mdoc_node *n;
1.1       kristaps 1375:
                   1376:        /*
                   1377:         * Process a new section.  Sections are either "named" or
                   1378:         * "custom"; custom sections are user-defined, while named ones
                   1379:         * usually follow a conventional order and may only appear in
                   1380:         * certain manual sections.
                   1381:         */
                   1382:
1.12      kristaps 1383:        buf[0] = 0;
1.1       kristaps 1384:
1.2       kristaps 1385:        for (n = mdoc->last->child; n; n = n->next) {
1.12      kristaps 1386:                /* XXX - copied from compact(). */
1.2       kristaps 1387:                assert(MDOC_TEXT == n->type);
1.12      kristaps 1388:
1.2       kristaps 1389:                if (strlcat(buf, n->string, 64) >= 64)
                   1390:                        return(nerr(mdoc, n, ETOOLONG));
                   1391:                if (NULL == n->next)
                   1392:                        continue;
                   1393:                if (strlcat(buf, " ", 64) >= 64)
                   1394:                        return(nerr(mdoc, n, ETOOLONG));
                   1395:        }
1.1       kristaps 1396:
                   1397:        sec = mdoc_atosec(buf);
                   1398:
1.12      kristaps 1399:        /*
                   1400:         * Check: NAME should always be first, CUSTOM has no roles,
                   1401:         * non-CUSTOM has a conventional order to be followed.
                   1402:         */
1.1       kristaps 1403:
1.12      kristaps 1404:        if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
                   1405:                return(verr(mdoc, ESECNAME));
1.1       kristaps 1406:        if (SEC_CUSTOM == sec)
                   1407:                return(1);
                   1408:        if (sec == mdoc->lastnamed)
1.2       kristaps 1409:                return(vwarn(mdoc, WSECREP));
1.1       kristaps 1410:        if (sec < mdoc->lastnamed)
1.2       kristaps 1411:                return(vwarn(mdoc, WSECOOO));
1.1       kristaps 1412:
1.12      kristaps 1413:        /*
                   1414:         * Check particular section/manual conventions.  LIBRARY can
                   1415:         * only occur in msec 2, 3 (TODO: are there more of these?).
                   1416:         */
1.1       kristaps 1417:
                   1418:        switch (sec) {
                   1419:        case (SEC_LIBRARY):
                   1420:                switch (mdoc->meta.msec) {
                   1421:                case (2):
                   1422:                        /* FALLTHROUGH */
                   1423:                case (3):
                   1424:                        break;
                   1425:                default:
1.2       kristaps 1426:                        return(vwarn(mdoc, WWRONGMSEC));
1.1       kristaps 1427:                }
                   1428:                break;
                   1429:        default:
                   1430:                break;
                   1431:        }
                   1432:
                   1433:        return(1);
                   1434: }
                   1435:
                   1436:
                   1437: static int
                   1438: pre_fd(PRE_ARGS)
                   1439: {
                   1440:
                   1441:        return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM));
                   1442: }

CVSweb