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

Annotation of mandoc/validate.c, Revision 1.60

1.60    ! kristaps    1: /* $Id: validate.c,v 1.59 2009/02/25 11:37:05 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.56      kristaps   20: #include <ctype.h>
1.8       kristaps   21: #include <stdlib.h>
1.1       kristaps   22:
                     23: #include "private.h"
                     24:
1.44      kristaps   25: /*
                     26:  * Pre- and post-validate macros as they're parsed.  Pre-validation
                     27:  * occurs when the macro has been detected and its arguments parsed.
                     28:  * Post-validation occurs when all child macros have also been parsed.
                     29:  * In the ELEMENT case, this is simply the parameters of the macro; in
                     30:  * the BLOCK case, this is the HEAD, BODY, TAIL and so on.
                     31:  */
                     32:
1.55      kristaps   33: #define        PRE_ARGS        struct mdoc *mdoc, const struct mdoc_node *n
                     34: #define        POST_ARGS       struct mdoc *mdoc
                     35:
                     36: typedef        int     (*v_pre)(PRE_ARGS);
                     37: typedef        int     (*v_post)(POST_ARGS);
1.14      kristaps   38:
1.36      kristaps   39: /* FIXME: some sections should only occur in specific msecs. */
                     40: /* FIXME: ignoring Pp. */
                     41: /* FIXME: math symbols. */
                     42:
1.14      kristaps   43: struct valids {
1.24      kristaps   44:        v_pre   *pre;
1.17      kristaps   45:        v_post  *post;
1.14      kristaps   46: };
1.1       kristaps   47:
1.37      kristaps   48: /* Utility checks. */
                     49:
1.55      kristaps   50: static int     check_parent(PRE_ARGS, int, enum mdoc_type);
                     51: static int     check_msec(PRE_ARGS, int, enum mdoc_msec *);
                     52: static int     check_stdarg(PRE_ARGS);
                     53:
                     54: static int     check_text(struct mdoc *,
                     55:                        size_t, size_t, const char *);
                     56:
1.51      kristaps   57: static int     err_child_lt(struct mdoc *, const char *, int);
1.59      kristaps   58: static int     warn_child_lt(struct mdoc *, const char *, int);
1.51      kristaps   59: static int     err_child_gt(struct mdoc *, const char *, int);
                     60: static int     warn_child_gt(struct mdoc *, const char *, int);
                     61: static int     err_child_eq(struct mdoc *, const char *, int);
                     62: static int     warn_child_eq(struct mdoc *, const char *, int);
                     63:
                     64: /* Utility auxiliaries. */
                     65:
                     66: static inline int count_child(struct mdoc *);
                     67: static inline int warn_count(struct mdoc *, const char *,
                     68:                        int, const char *, int);
                     69: static inline int err_count(struct mdoc *, const char *,
                     70:                        int, const char *, int);
1.11      kristaps   71:
1.37      kristaps   72: /* Specific pre-child-parse routines. */
                     73:
1.55      kristaps   74: static int     pre_display(PRE_ARGS);
                     75: static int     pre_sh(PRE_ARGS);
                     76: static int     pre_ss(PRE_ARGS);
                     77: static int     pre_bd(PRE_ARGS);
                     78: static int     pre_bl(PRE_ARGS);
                     79: static int     pre_it(PRE_ARGS);
                     80: static int     pre_cd(PRE_ARGS);
                     81: static int     pre_er(PRE_ARGS);
                     82: static int     pre_ex(PRE_ARGS);
                     83: static int     pre_rv(PRE_ARGS);
                     84: static int     pre_an(PRE_ARGS);
                     85: static int     pre_st(PRE_ARGS);
                     86: static int     pre_prologue(PRE_ARGS);
                     87: static int     pre_prologue(PRE_ARGS);
                     88: static int     pre_prologue(PRE_ARGS);
1.24      kristaps   89:
1.37      kristaps   90: /* Specific post-child-parse routines. */
                     91:
1.55      kristaps   92: static int     herr_ge1(POST_ARGS);
1.59      kristaps   93: static int     hwarn_le1(POST_ARGS);
1.55      kristaps   94: static int     herr_eq0(POST_ARGS);
                     95: static int     eerr_eq0(POST_ARGS);
                     96: static int     eerr_le1(POST_ARGS);
                     97: static int     eerr_le2(POST_ARGS);
                     98: static int     eerr_eq1(POST_ARGS);
                     99: static int     eerr_ge1(POST_ARGS);
                    100: static int     ewarn_eq0(POST_ARGS);
                    101: static int     ewarn_eq1(POST_ARGS);
                    102: static int     bwarn_ge1(POST_ARGS);
1.58      kristaps  103: static int     hwarn_eq1(POST_ARGS);
1.55      kristaps  104: static int     ewarn_ge1(POST_ARGS);
                    105: static int     ebool(POST_ARGS);
                    106:
                    107: static int     post_sh(POST_ARGS);
                    108: static int     post_sh_body(POST_ARGS);
                    109: static int     post_sh_head(POST_ARGS);
1.57      kristaps  110: static int     post_fd(POST_ARGS);
1.55      kristaps  111: static int     post_bl(POST_ARGS);
                    112: static int     post_it(POST_ARGS);
                    113: static int     post_ex(POST_ARGS);
                    114: static int     post_an(POST_ARGS);
                    115: static int     post_at(POST_ARGS);
                    116: static int     post_xr(POST_ARGS);
                    117: static int     post_nm(POST_ARGS);
                    118: static int     post_bf(POST_ARGS);
                    119: static int     post_root(POST_ARGS);
1.37      kristaps  120:
                    121: /* Collections of pre-child-parse routines. */
1.17      kristaps  122:
1.24      kristaps  123: static v_pre   pres_prologue[] = { pre_prologue, NULL };
                    124: static v_pre   pres_d1[] = { pre_display, NULL };
                    125: static v_pre   pres_bd[] = { pre_display, pre_bd, NULL };
                    126: static v_pre   pres_bl[] = { pre_bl, NULL };
1.25      kristaps  127: static v_pre   pres_it[] = { pre_it, NULL };
1.33      kristaps  128: static v_pre   pres_ss[] = { pre_ss, NULL };
                    129: static v_pre   pres_sh[] = { pre_sh, NULL };
                    130: static v_pre   pres_cd[] = { pre_cd, NULL };
                    131: static v_pre   pres_er[] = { pre_er, NULL };
                    132: static v_pre   pres_ex[] = { pre_ex, NULL };
1.36      kristaps  133: static v_pre   pres_rv[] = { pre_rv, NULL };
1.35      kristaps  134: static v_pre   pres_an[] = { pre_an, NULL };
1.36      kristaps  135: static v_pre   pres_st[] = { pre_st, NULL };
1.24      kristaps  136:
1.37      kristaps  137: /* Collections of post-child-parse routines. */
                    138:
                    139: static v_post  posts_bool[] = { eerr_eq1, ebool, NULL };
                    140: static v_post  posts_bd[] = { herr_eq0, bwarn_ge1, NULL };
                    141: static v_post  posts_text[] = { eerr_ge1, NULL };
                    142: static v_post  posts_wtext[] = { ewarn_ge1, NULL };
                    143: static v_post  posts_notext[] = { eerr_eq0, NULL };
1.43      kristaps  144: static v_post  posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
1.37      kristaps  145: static v_post  posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
                    146: static v_post  posts_bl[] = { herr_eq0, bwarn_ge1, post_bl, NULL };
1.25      kristaps  147: static v_post  posts_it[] = { post_it, NULL };
1.39      kristaps  148: static v_post  posts_in[] = { ewarn_eq1, NULL };
1.37      kristaps  149: static v_post  posts_ss[] = { herr_ge1, NULL };
1.52      kristaps  150: static v_post  posts_pf[] = { eerr_eq1, NULL };
1.37      kristaps  151: static v_post  posts_pp[] = { ewarn_eq0, NULL };
                    152: static v_post  posts_ex[] = { eerr_le1, post_ex, NULL };
1.35      kristaps  153: static v_post  posts_an[] = { post_an, NULL };
1.37      kristaps  154: static v_post  posts_at[] = { post_at, NULL };
                    155: static v_post  posts_xr[] = { eerr_ge1, eerr_le2, post_xr, NULL };
                    156: static v_post  posts_nm[] = { post_nm, NULL };
1.59      kristaps  157: static v_post  posts_bf[] = { hwarn_le1, post_bf, NULL };
1.45      kristaps  158: static v_post  posts_rs[] = { herr_eq0, bwarn_ge1, NULL };
1.58      kristaps  159: static v_post  posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
1.45      kristaps  160: static v_post  posts_bk[] = { herr_eq0, bwarn_ge1, NULL };
1.57      kristaps  161: static v_post  posts_fd[] = { ewarn_ge1, post_fd, NULL };
1.9       kristaps  162:
1.37      kristaps  163: /* Per-macro pre- and post-child-check routine collections. */
1.12      kristaps  164:
1.9       kristaps  165: const  struct valids mdoc_valids[MDOC_MAX] = {
1.51      kristaps  166:        { NULL, NULL },                         /* \" */
                    167:        { pres_prologue, posts_text },          /* Dd */
                    168:        { pres_prologue, NULL },                /* Dt */
                    169:        { pres_prologue, NULL },                /* Os */
                    170:        { pres_sh, posts_sh },                  /* Sh */
                    171:        { pres_ss, posts_ss },                  /* Ss */
                    172:        { NULL, posts_pp },                     /* Pp */
                    173:        { pres_d1, posts_wline },               /* D1 */
                    174:        { pres_d1, posts_wline },               /* Dl */
                    175:        { pres_bd, posts_bd },                  /* Bd */
                    176:        { NULL, NULL },                         /* Ed */
                    177:        { pres_bl, posts_bl },                  /* Bl */
                    178:        { NULL, NULL },                         /* El */
                    179:        { pres_it, posts_it },                  /* It */
                    180:        { NULL, posts_text },                   /* Ad */
                    181:        { pres_an, posts_an },                  /* An */
                    182:        { NULL, NULL },                         /* Ar */
                    183:        { pres_cd, posts_text },                /* Cd */
                    184:        { NULL, NULL },                         /* Cm */
                    185:        { NULL, posts_text },                   /* Dv */
                    186:        { pres_er, posts_text },                /* Er */
                    187:        { NULL, posts_text },                   /* Ev */
                    188:        { pres_ex, posts_ex },                  /* Ex */
                    189:        { NULL, posts_text },                   /* Fa */
1.57      kristaps  190:        { NULL, posts_fd },                     /* Fd */
1.51      kristaps  191:        { NULL, NULL },                         /* Fl */
                    192:        { NULL, posts_text },                   /* Fn */
                    193:        { NULL, posts_wtext },                  /* Ft */
                    194:        { NULL, posts_text },                   /* Ic */
                    195:        { NULL, posts_in },                     /* In */
                    196:        { NULL, posts_text },                   /* Li */
                    197:        { NULL, posts_wtext },                  /* Nd */
                    198:        { NULL, posts_nm },                     /* Nm */
                    199:        { NULL, posts_wline },                  /* Op */
                    200:        { NULL, NULL },                         /* Ot */
                    201:        { NULL, NULL },                         /* Pa */
                    202:        { pres_rv, posts_notext },              /* Rv */
                    203:        { pres_st, posts_notext },              /* St */
                    204:        { NULL, posts_text },                   /* Va */
                    205:        { NULL, posts_text },                   /* Vt */
                    206:        { NULL, posts_xr },                     /* Xr */
                    207:        { NULL, posts_text },                   /* %A */
                    208:        { NULL, posts_text },                   /* %B */
                    209:        { NULL, posts_text },                   /* %D */
                    210:        { NULL, posts_text },                   /* %I */
                    211:        { NULL, posts_text },                   /* %J */
                    212:        { NULL, posts_text },                   /* %N */
                    213:        { NULL, posts_text },                   /* %O */
                    214:        { NULL, posts_text },                   /* %P */
                    215:        { NULL, posts_text },                   /* %R */
                    216:        { NULL, posts_text },                   /* %T */
                    217:        { NULL, posts_text },                   /* %V */
                    218:        { NULL, NULL },                         /* Ac */
                    219:        { NULL, NULL },                         /* Ao */
                    220:        { NULL, posts_wline },                  /* Aq */
                    221:        { NULL, posts_at },                     /* At */
                    222:        { NULL, NULL },                         /* Bc */
                    223:        { NULL, posts_bf },                     /* Bf */
                    224:        { NULL, NULL },                         /* Bo */
                    225:        { NULL, posts_wline },                  /* Bq */
                    226:        { NULL, NULL },                         /* Bsx */
                    227:        { NULL, NULL },                         /* Bx */
                    228:        { NULL, posts_bool },                   /* Db */
                    229:        { NULL, NULL },                         /* Dc */
                    230:        { NULL, NULL },                         /* Do */
                    231:        { NULL, posts_wline },                  /* Dq */
                    232:        { NULL, NULL },                         /* Ec */
                    233:        { NULL, NULL },                         /* Ef */
                    234:        { NULL, posts_text },                   /* Em */
                    235:        { NULL, NULL },                         /* Eo */
                    236:        { NULL, NULL },                         /* Fx */
                    237:        { NULL, posts_text },                   /* Ms */
                    238:        { NULL, posts_notext },                 /* No */
                    239:        { NULL, posts_notext },                 /* Ns */
                    240:        { NULL, NULL },                         /* Nx */
                    241:        { NULL, NULL },                         /* Ox */
                    242:        { NULL, NULL },                         /* Pc */
1.52      kristaps  243:        { NULL, posts_pf },                     /* Pf */
1.51      kristaps  244:        { NULL, NULL },                         /* Po */
                    245:        { NULL, posts_wline },                  /* Pq */
                    246:        { NULL, NULL },                         /* Qc */
                    247:        { NULL, posts_wline },                  /* Ql */
                    248:        { NULL, NULL },                         /* Qo */
                    249:        { NULL, posts_wline },                  /* Qq */
                    250:        { NULL, NULL },                         /* Re */
                    251:        { NULL, posts_rs },                     /* Rs */
                    252:        { NULL, NULL },                         /* Sc */
                    253:        { NULL, NULL },                         /* So */
                    254:        { NULL, posts_wline },                  /* Sq */
                    255:        { NULL, posts_bool },                   /* Sm */
                    256:        { NULL, posts_text },                   /* Sx */
                    257:        { NULL, posts_text },                   /* Sy */
                    258:        { NULL, posts_text },                   /* Tn */
                    259:        { NULL, NULL },                         /* Ux */
                    260:        { NULL, NULL },                         /* Xc */
                    261:        { NULL, NULL },                         /* Xo */
                    262:        { NULL, posts_fo },                     /* Fo */
                    263:        { NULL, NULL },                         /* Fc */
                    264:        { NULL, NULL },                         /* Oo */
                    265:        { NULL, NULL },                         /* Oc */
                    266:        { NULL, posts_bk },                     /* Bk */
                    267:        { NULL, NULL },                         /* Ek */
                    268:        { NULL, posts_notext },                 /* Bt */
                    269:        { NULL, NULL },                         /* Hf */
                    270:        { NULL, NULL },                         /* Fr */
                    271:        { NULL, posts_notext },                 /* Ud */
1.9       kristaps  272: };
1.6       kristaps  273:
                    274:
1.57      kristaps  275: int
                    276: mdoc_valid_pre(struct mdoc *mdoc,
                    277:                const struct mdoc_node *node)
                    278: {
                    279:        v_pre           *p;
                    280:        struct mdoc_arg *argv;
                    281:        size_t           argc, i, j, line, pos;
                    282:        const char      *tp;
                    283:
                    284:        if (MDOC_TEXT == node->type) {
                    285:                tp = node->data.text.string;
                    286:                line = node->line;
                    287:                pos = node->pos;
                    288:                return(check_text(mdoc, line, pos, tp));
                    289:        }
                    290:
                    291:        if (MDOC_BLOCK == node->type || MDOC_ELEM == node->type) {
                    292:                argv = MDOC_BLOCK == node->type ?
                    293:                        node->data.block.argv :
                    294:                        node->data.elem.argv;
                    295:                argc = MDOC_BLOCK == node->type ?
                    296:                        node->data.block.argc :
                    297:                        node->data.elem.argc;
                    298:
                    299:                for (i = 0; i < argc; i++) {
                    300:                        if (0 == argv[i].sz)
                    301:                                continue;
                    302:                        for (j = 0; j < argv[i].sz; j++) {
                    303:                                tp = argv[i].value[j];
                    304:                                line = argv[i].line;
                    305:                                pos = argv[i].pos;
                    306:                                if ( ! check_text(mdoc, line, pos, tp))
                    307:                                        return(0);
                    308:                        }
                    309:                }
                    310:        }
                    311:
                    312:        if (NULL == mdoc_valids[node->tok].pre)
                    313:                return(1);
                    314:        for (p = mdoc_valids[node->tok].pre; *p; p++)
                    315:                if ( ! (*p)(mdoc, node))
                    316:                        return(0);
                    317:        return(1);
                    318: }
                    319:
                    320:
                    321: int
                    322: mdoc_valid_post(struct mdoc *mdoc)
                    323: {
                    324:        v_post          *p;
                    325:
                    326:        /*
                    327:         * This check occurs after the macro's children have been filled
                    328:         * in: postfix validation.  Since this happens when we're
                    329:         * rewinding the scope tree, it's possible to have multiple
                    330:         * invocations (as by design, for now), we set bit MDOC_VALID to
                    331:         * indicate that we've validated.
                    332:         */
                    333:
                    334:        if (MDOC_VALID & mdoc->last->flags)
                    335:                return(1);
                    336:        mdoc->last->flags |= MDOC_VALID;
                    337:
                    338:        if (MDOC_TEXT == mdoc->last->type)
                    339:                return(1);
                    340:        if (MDOC_ROOT == mdoc->last->type)
                    341:                return(post_root(mdoc));
                    342:
                    343:        if (NULL == mdoc_valids[mdoc->last->tok].post)
                    344:                return(1);
                    345:        for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
                    346:                if ( ! (*p)(mdoc))
                    347:                        return(0);
                    348:
                    349:        return(1);
                    350: }
                    351:
                    352:
                    353:
1.51      kristaps  354: static inline int
                    355: warn_count(struct mdoc *m, const char *k,
                    356:                int want, const char *v, int has)
                    357: {
                    358:
1.55      kristaps  359:        return(mdoc_warn(m, WARN_SYNTAX,
1.58      kristaps  360:                                "suggests %s %s %d (has %d)",
                    361:                                v, k, want, has));
1.51      kristaps  362: }
                    363:
                    364:
                    365: static inline int
                    366: err_count(struct mdoc *m, const char *k,
                    367:                int want, const char *v, int has)
                    368: {
                    369:
1.58      kristaps  370:        return(mdoc_err(m, "requires %s %s %d (has %d)",
                    371:                                v, k, want, has));
1.51      kristaps  372: }
                    373:
                    374:
                    375: static inline int
                    376: count_child(struct mdoc *mdoc)
1.36      kristaps  377: {
1.51      kristaps  378:        int               i;
1.36      kristaps  379:        struct mdoc_node *n;
                    380:
                    381:        for (i = 0, n = mdoc->last->child; n; n = n->next, i++)
                    382:                /* Do nothing */ ;
1.53      kristaps  383:
1.36      kristaps  384:        return(i);
                    385: }
                    386:
                    387:
1.53      kristaps  388: /*
                    389:  * Build these up with macros because they're basically the same check
                    390:  * for different inequalities.  Yes, this could be done with functions,
                    391:  * but this is reasonable for now.
                    392:  */
1.36      kristaps  393:
1.53      kristaps  394: #define CHECK_CHILD_DEFN(lvl, name, ineq)                      \
                    395: static int                                                     \
                    396: lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz)   \
                    397: {                                                              \
                    398:        int i;                                                  \
                    399:        if ((i = count_child(mdoc)) ineq sz)                    \
                    400:                return(1);                                      \
                    401:        return(lvl##_count(mdoc, #ineq, sz, p, i));             \
                    402: }
                    403:
                    404: #define CHECK_BODY_DEFN(name, lvl, func, num)                  \
                    405: static int                                                     \
1.55      kristaps  406: b##lvl##_##name(POST_ARGS)                                     \
1.53      kristaps  407: {                                                              \
                    408:        if (MDOC_BODY != mdoc->last->type)                      \
                    409:                return(1);                                      \
                    410:        return(func(mdoc, "multiline parameters", (num)));      \
                    411: }
                    412:
                    413: #define CHECK_ELEM_DEFN(name, lvl, func, num)                  \
                    414: static int                                                     \
1.55      kristaps  415: e##lvl##_##name(POST_ARGS)                                     \
1.53      kristaps  416: {                                                              \
                    417:        assert(MDOC_ELEM == mdoc->last->type);                  \
                    418:        return(func(mdoc, "line parameters", (num)));           \
                    419: }
                    420:
                    421: #define CHECK_HEAD_DEFN(name, lvl, func, num)                  \
                    422: static int                                                     \
1.55      kristaps  423: h##lvl##_##name(POST_ARGS)                                     \
1.53      kristaps  424: {                                                              \
                    425:        if (MDOC_HEAD != mdoc->last->type)                      \
                    426:                return(1);                                      \
1.58      kristaps  427:        return(func(mdoc, "line parameters", (num)));           \
1.36      kristaps  428: }
                    429:
                    430:
1.53      kristaps  431: CHECK_CHILD_DEFN(warn, gt, >)                  /* warn_child_gt() */
                    432: CHECK_CHILD_DEFN(err, gt, >)                   /* err_child_gt() */
                    433: CHECK_CHILD_DEFN(warn, eq, ==)                 /* warn_child_eq() */
                    434: CHECK_CHILD_DEFN(err, eq, ==)                  /* err_child_eq() */
                    435: CHECK_CHILD_DEFN(err, lt, <)                   /* err_child_lt() */
1.59      kristaps  436: CHECK_CHILD_DEFN(warn, lt, <)                  /* warn_child_lt() */
1.53      kristaps  437: CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0)   /* bwarn_ge1() */
                    438: CHECK_ELEM_DEFN(eq1, warn, warn_child_eq, 1)   /* ewarn_eq1() */
                    439: CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0)   /* ewarn_eq0() */
                    440: CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0)   /* ewarn_gt1() */
                    441: CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1)     /* eerr_eq1() */
                    442: CHECK_ELEM_DEFN(le2, err, err_child_lt, 3)     /* eerr_le2() */
                    443: CHECK_ELEM_DEFN(le1, err, err_child_lt, 2)     /* eerr_le1() */
                    444: CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0)     /* eerr_eq0() */
                    445: CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0)     /* eerr_ge1() */
                    446: CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0)     /* herr_eq0() */
1.59      kristaps  447: CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2)   /* hwarn_le1() */
1.53      kristaps  448: CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0)     /* herr_ge1() */
1.58      kristaps  449: CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1)   /* hwarn_eq1() */
1.36      kristaps  450:
                    451:
                    452: static int
1.55      kristaps  453: check_stdarg(PRE_ARGS)
1.36      kristaps  454: {
                    455:
1.55      kristaps  456:        if (MDOC_Std == n->data.elem.argv[0].arg &&
                    457:                        1 == n->data.elem.argc)
1.36      kristaps  458:                return(1);
1.51      kristaps  459:
1.55      kristaps  460:        return(mdoc_nwarn(mdoc, n, WARN_COMPAT,
1.53      kristaps  461:                                "one argument suggested"));
1.36      kristaps  462: }
                    463:
                    464:
                    465: static int
1.55      kristaps  466: check_msec(PRE_ARGS, int sz, enum mdoc_msec *msecs)
1.33      kristaps  467: {
                    468:        int              i;
                    469:
                    470:        for (i = 0; i < sz; i++)
                    471:                if (msecs[i] == mdoc->meta.msec)
                    472:                        return(1);
1.55      kristaps  473:        return(mdoc_nwarn(mdoc, n, WARN_COMPAT,
                    474:                                "invalid manual section"));
                    475: }
                    476:
                    477:
                    478: static int
                    479: check_text(struct mdoc *mdoc, size_t line, size_t pos, const char *p)
                    480: {
                    481:        size_t           c;
                    482:
                    483:        for ( ; *p; p++) {
1.60    ! kristaps  484:                if ( ! isprint((int)*p) && '\t' != *p)
1.56      kristaps  485:                        return(mdoc_perr(mdoc, line, pos,
                    486:                                        "invalid characters"));
1.55      kristaps  487:                if ('\\' != *p)
                    488:                        continue;
                    489:                if ((c = mdoc_isescape(p))) {
                    490:                        p += (c - 1);
                    491:                        continue;
                    492:                }
                    493:                return(mdoc_perr(mdoc, line, pos,
1.56      kristaps  494:                                        "invalid escape sequence"));
1.55      kristaps  495:        }
                    496:
                    497:        return(1);
1.14      kristaps  498: }
                    499:
                    500:
1.55      kristaps  501:
                    502:
1.14      kristaps  503: static int
1.55      kristaps  504: check_parent(PRE_ARGS, int tok, enum mdoc_type t)
1.54      kristaps  505: {
                    506:
                    507:        assert(n->parent);
                    508:        if ((MDOC_ROOT == t || tok == n->parent->tok) &&
                    509:                        (t == n->parent->type))
                    510:                return(1);
                    511:
                    512:        return(mdoc_nerr(mdoc, n, "require parent %s",
                    513:                MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]));
                    514: }
                    515:
                    516:
                    517:
                    518: static int
1.55      kristaps  519: pre_display(PRE_ARGS)
1.23      kristaps  520: {
1.55      kristaps  521:        struct mdoc_node *node;
1.23      kristaps  522:
1.53      kristaps  523:        /* Display elements (`Bd', `D1'...) cannot be nested. */
                    524:
1.55      kristaps  525:        if (MDOC_BLOCK != n->type)
1.24      kristaps  526:                return(1);
                    527:
1.38      kristaps  528:        /* LINTED */
1.55      kristaps  529:        for (node = mdoc->last->parent; node; node = node->parent)
                    530:                if (MDOC_BLOCK == node->type)
                    531:                        if (MDOC_Bd == node->tok)
1.23      kristaps  532:                                break;
1.55      kristaps  533:        if (NULL == node)
1.23      kristaps  534:                return(1);
1.53      kristaps  535:
1.55      kristaps  536:        return(mdoc_nerr(mdoc, n, "displays may not be nested"));
1.23      kristaps  537: }
                    538:
                    539:
                    540: static int
1.55      kristaps  541: pre_bl(PRE_ARGS)
1.24      kristaps  542: {
1.60    ! kristaps  543:        int              type, i;
1.24      kristaps  544:        struct mdoc_arg *argv;
1.53      kristaps  545:        size_t           argc;
1.24      kristaps  546:
1.55      kristaps  547:        if (MDOC_BLOCK != n->type)
1.24      kristaps  548:                return(1);
                    549:
1.55      kristaps  550:        argc = n->data.block.argc;
1.24      kristaps  551:
1.53      kristaps  552:        /* Make sure that only one type of list is specified.  */
                    553:
1.38      kristaps  554:        /* LINTED */
1.60    ! kristaps  555:        for (i = 0, type = 0; i < (int)argc; i++) {
1.55      kristaps  556:                argv = &n->data.block.argv[i];
1.53      kristaps  557:
1.24      kristaps  558:                switch (argv->arg) {
                    559:                case (MDOC_Bullet):
                    560:                        /* FALLTHROUGH */
                    561:                case (MDOC_Dash):
                    562:                        /* FALLTHROUGH */
                    563:                case (MDOC_Enum):
                    564:                        /* FALLTHROUGH */
                    565:                case (MDOC_Hyphen):
                    566:                        /* FALLTHROUGH */
                    567:                case (MDOC_Item):
                    568:                        /* FALLTHROUGH */
                    569:                case (MDOC_Tag):
                    570:                        /* FALLTHROUGH */
                    571:                case (MDOC_Diag):
                    572:                        /* FALLTHROUGH */
                    573:                case (MDOC_Hang):
                    574:                        /* FALLTHROUGH */
                    575:                case (MDOC_Ohang):
                    576:                        /* FALLTHROUGH */
                    577:                case (MDOC_Inset):
1.26      kristaps  578:                        /* FALLTHROUGH */
                    579:                case (MDOC_Column):
1.53      kristaps  580:                        if (0 == type++)
                    581:                                break;
                    582:                        return(mdoc_perr(mdoc, argv->line, argv->pos,
                    583:                                        "multiple types specified"));
1.24      kristaps  584:                default:
                    585:                        break;
                    586:                }
                    587:        }
1.53      kristaps  588:
                    589:        if (type)
                    590:                return(1);
                    591:        return(mdoc_err(mdoc, "no type specified"));
1.24      kristaps  592: }
                    593:
                    594:
                    595: static int
1.55      kristaps  596: pre_bd(PRE_ARGS)
1.24      kristaps  597: {
1.53      kristaps  598:        int              type, err, i;
1.24      kristaps  599:        struct mdoc_arg *argv;
1.53      kristaps  600:        size_t           argc;
1.24      kristaps  601:
1.55      kristaps  602:        if (MDOC_BLOCK != n->type)
1.24      kristaps  603:                return(1);
                    604:
1.55      kristaps  605:        argc = n->data.block.argc;
1.24      kristaps  606:
1.53      kristaps  607:        /* Make sure that only one type of display is specified.  */
                    608:
1.38      kristaps  609:        /* LINTED */
1.53      kristaps  610:        for (i = 0, err = type = 0; ! err && i < (int)argc; i++) {
1.55      kristaps  611:                argv = &n->data.block.argv[i];
1.53      kristaps  612:
1.24      kristaps  613:                switch (argv->arg) {
                    614:                case (MDOC_Ragged):
                    615:                        /* FALLTHROUGH */
                    616:                case (MDOC_Unfilled):
                    617:                        /* FALLTHROUGH */
1.29      kristaps  618:                case (MDOC_Filled):
                    619:                        /* FALLTHROUGH */
1.24      kristaps  620:                case (MDOC_Literal):
                    621:                        /* FALLTHROUGH */
                    622:                case (MDOC_File):
1.53      kristaps  623:                        if (0 == type++)
                    624:                                break;
                    625:                        return(mdoc_perr(mdoc, argv->line, argv->pos,
                    626:                                        "multiple types specified"));
1.24      kristaps  627:                default:
                    628:                        break;
                    629:                }
                    630:        }
1.53      kristaps  631:
                    632:        if (type)
                    633:                return(1);
                    634:        return(mdoc_err(mdoc, "no type specified"));
1.24      kristaps  635: }
                    636:
                    637:
                    638: static int
1.55      kristaps  639: pre_ss(PRE_ARGS)
1.33      kristaps  640: {
                    641:
1.55      kristaps  642:        if (MDOC_BLOCK != n->type)
1.33      kristaps  643:                return(1);
1.55      kristaps  644:        return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
1.33      kristaps  645: }
                    646:
                    647:
                    648: static int
1.55      kristaps  649: pre_sh(PRE_ARGS)
1.33      kristaps  650: {
                    651:
1.55      kristaps  652:        if (MDOC_BLOCK != n->type)
1.33      kristaps  653:                return(1);
1.55      kristaps  654:        return(check_parent(mdoc, n, -1, MDOC_ROOT));
1.33      kristaps  655: }
                    656:
                    657:
                    658: static int
1.55      kristaps  659: pre_it(PRE_ARGS)
1.53      kristaps  660: {
                    661:
                    662:        /* TODO: -width attribute must be specified for -tag. */
                    663:        /* TODO: children too big for -width? */
                    664:
1.55      kristaps  665:        if (MDOC_BLOCK != n->type)
1.53      kristaps  666:                return(1);
1.55      kristaps  667:        return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
1.53      kristaps  668: }
                    669:
                    670:
                    671: static int
1.55      kristaps  672: pre_st(PRE_ARGS)
1.36      kristaps  673: {
                    674:
1.55      kristaps  675:        if (1 == n->data.elem.argc)
1.36      kristaps  676:                return(1);
1.55      kristaps  677:        return(mdoc_nerr(mdoc, n, "one argument required"));
1.36      kristaps  678: }
                    679:
                    680:
                    681: static int
1.55      kristaps  682: pre_an(PRE_ARGS)
1.35      kristaps  683: {
1.36      kristaps  684:
1.55      kristaps  685:        if (1 >= n->data.elem.argc)
1.35      kristaps  686:                return(1);
1.55      kristaps  687:        return(mdoc_nerr(mdoc, n, "one argument allowed"));
1.35      kristaps  688: }
                    689:
                    690:
                    691: static int
1.55      kristaps  692: pre_rv(PRE_ARGS)
1.36      kristaps  693: {
1.53      kristaps  694:        enum mdoc_msec msecs[] = { MSEC_2, MSEC_3 };
1.36      kristaps  695:
1.55      kristaps  696:        if ( ! check_msec(mdoc, n, 2, msecs))
1.36      kristaps  697:                return(0);
1.55      kristaps  698:        return(check_stdarg(mdoc, n));
1.36      kristaps  699: }
                    700:
                    701:
                    702: static int
1.55      kristaps  703: pre_ex(PRE_ARGS)
1.33      kristaps  704: {
1.53      kristaps  705:        enum mdoc_msec msecs[] = { MSEC_1, MSEC_6, MSEC_8 };
1.35      kristaps  706:
1.55      kristaps  707:        if ( ! check_msec(mdoc, n, 3, msecs))
1.35      kristaps  708:                return(0);
1.55      kristaps  709:        return(check_stdarg(mdoc, n));
1.33      kristaps  710: }
                    711:
                    712:
                    713: static int
1.55      kristaps  714: pre_er(PRE_ARGS)
1.33      kristaps  715: {
1.53      kristaps  716:        enum mdoc_msec msecs[] = { MSEC_2 };
1.33      kristaps  717:
1.55      kristaps  718:        return(check_msec(mdoc, n, 1, msecs));
1.33      kristaps  719: }
                    720:
                    721:
                    722: static int
1.55      kristaps  723: pre_cd(PRE_ARGS)
1.33      kristaps  724: {
1.53      kristaps  725:        enum mdoc_msec msecs[] = { MSEC_4 };
1.33      kristaps  726:
1.55      kristaps  727:        return(check_msec(mdoc, n, 1, msecs));
1.33      kristaps  728: }
                    729:
                    730:
                    731: static int
1.55      kristaps  732: pre_prologue(PRE_ARGS)
1.20      kristaps  733: {
                    734:
1.46      kristaps  735:        if (SEC_PROLOGUE != mdoc->lastnamed)
1.55      kristaps  736:                return(mdoc_nerr(mdoc, n, "prologue only"));
1.20      kristaps  737:
                    738:        /* Check for ordering. */
                    739:
1.55      kristaps  740:        switch (n->tok) {
1.20      kristaps  741:        case (MDOC_Os):
1.36      kristaps  742:                if (mdoc->meta.title && mdoc->meta.date)
1.20      kristaps  743:                        break;
1.55      kristaps  744:                return(mdoc_nerr(mdoc, n, "prologue out-of-order"));
1.20      kristaps  745:        case (MDOC_Dt):
1.36      kristaps  746:                if (NULL == mdoc->meta.title && mdoc->meta.date)
1.20      kristaps  747:                        break;
1.55      kristaps  748:                return(mdoc_nerr(mdoc, n, "prologue out-of-order"));
1.20      kristaps  749:        case (MDOC_Dd):
1.36      kristaps  750:                if (NULL == mdoc->meta.title && 0 == mdoc->meta.date)
1.20      kristaps  751:                        break;
1.55      kristaps  752:                return(mdoc_nerr(mdoc, n, "prologue out-of-order"));
1.20      kristaps  753:        default:
                    754:                abort();
                    755:                /* NOTREACHED */
                    756:        }
                    757:
                    758:        /* Check for repetition. */
                    759:
1.55      kristaps  760:        switch (n->tok) {
1.20      kristaps  761:        case (MDOC_Os):
1.36      kristaps  762:                if (NULL == mdoc->meta.os)
1.20      kristaps  763:                        return(1);
                    764:                break;
                    765:        case (MDOC_Dd):
                    766:                if (0 == mdoc->meta.date)
                    767:                        return(1);
                    768:                break;
                    769:        case (MDOC_Dt):
1.36      kristaps  770:                if (NULL == mdoc->meta.title)
1.20      kristaps  771:                        return(1);
                    772:                break;
                    773:        default:
                    774:                abort();
                    775:                /* NOTREACHED */
                    776:        }
                    777:
1.55      kristaps  778:        return(mdoc_nerr(mdoc, n, "prologue repetition"));
1.20      kristaps  779: }
                    780:
                    781:
1.35      kristaps  782: static int
1.55      kristaps  783: post_bf(POST_ARGS)
1.41      kristaps  784: {
                    785:        char             *p;
                    786:        struct mdoc_node *head;
                    787:
                    788:        if (MDOC_BLOCK != mdoc->last->type)
                    789:                return(1);
1.53      kristaps  790:
1.41      kristaps  791:        head = mdoc->last->data.block.head;
                    792:
                    793:        if (0 == mdoc->last->data.block.argc) {
1.53      kristaps  794:                if (NULL == head->child)
                    795:                        return(mdoc_err(mdoc, "argument expected"));
                    796:
                    797:                p = head->child->data.text.string;
                    798:                if (xstrcmp(p, "Em"))
                    799:                        return(1);
                    800:                else if (xstrcmp(p, "Li"))
                    801:                        return(1);
                    802:                else if (xstrcmp(p, "Sm"))
                    803:                        return(1);
                    804:                return(mdoc_nerr(mdoc, head->child, "invalid font"));
1.41      kristaps  805:        }
1.53      kristaps  806:
1.41      kristaps  807:        if (head->child)
1.53      kristaps  808:                return(mdoc_err(mdoc, "argument expected"));
                    809:
1.41      kristaps  810:        if (1 == mdoc->last->data.block.argc)
                    811:                return(1);
1.53      kristaps  812:        return(mdoc_err(mdoc, "argument expected"));
1.41      kristaps  813: }
                    814:
                    815:
                    816: static int
1.55      kristaps  817: post_nm(POST_ARGS)
1.37      kristaps  818: {
                    819:
                    820:        if (mdoc->last->child)
                    821:                return(1);
                    822:        if (mdoc->meta.name)
                    823:                return(1);
1.53      kristaps  824:        return(mdoc_err(mdoc, "not yet invoked with name"));
1.37      kristaps  825: }
                    826:
                    827:
                    828: static int
1.55      kristaps  829: post_xr(POST_ARGS)
1.36      kristaps  830: {
                    831:        struct mdoc_node *n;
                    832:
                    833:        if (NULL == (n = mdoc->last->child->next))
                    834:                return(1);
                    835:        if (MSEC_DEFAULT != mdoc_atomsec(n->data.text.string))
                    836:                return(1);
                    837:        return(mdoc_nerr(mdoc, n, "invalid manual section"));
                    838: }
                    839:
                    840:
                    841: static int
1.55      kristaps  842: post_at(POST_ARGS)
1.36      kristaps  843: {
                    844:
1.37      kristaps  845:        if (NULL == mdoc->last->child)
                    846:                return(1);
1.36      kristaps  847:        if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string))
                    848:                return(1);
1.53      kristaps  849:        return(mdoc_err(mdoc, "require valid symbol"));
1.36      kristaps  850: }
                    851:
                    852:
                    853: static int
1.55      kristaps  854: post_an(POST_ARGS)
1.35      kristaps  855: {
                    856:
                    857:        if (0 != mdoc->last->data.elem.argc) {
                    858:                if (NULL == mdoc->last->child)
                    859:                        return(1);
1.53      kristaps  860:                return(mdoc_err(mdoc, "argument(s) expected"));
1.35      kristaps  861:        }
                    862:
                    863:        if (mdoc->last->child)
                    864:                return(1);
1.53      kristaps  865:        return(mdoc_err(mdoc, "argument(s) expected"));
1.35      kristaps  866: }
                    867:
                    868:
                    869: static int
1.55      kristaps  870: post_ex(POST_ARGS)
1.35      kristaps  871: {
                    872:
                    873:        if (0 == mdoc->last->data.elem.argc) {
                    874:                if (mdoc->last->child)
                    875:                        return(1);
1.53      kristaps  876:                return(mdoc_err(mdoc, "argument(s) expected"));
1.35      kristaps  877:        }
                    878:        if (mdoc->last->child)
1.53      kristaps  879:                return(mdoc_err(mdoc, "argument(s) expected"));
1.35      kristaps  880:        if (1 != mdoc->last->data.elem.argc)
1.53      kristaps  881:                return(mdoc_err(mdoc, "argument(s) expected"));
1.35      kristaps  882:        if (MDOC_Std != mdoc->last->data.elem.argv[0].arg)
1.53      kristaps  883:                return(mdoc_err(mdoc, "argument(s) expected"));
                    884:
1.35      kristaps  885:        return(1);
                    886: }
                    887:
                    888:
1.25      kristaps  889: static int
1.55      kristaps  890: post_it(POST_ARGS)
1.25      kristaps  891: {
1.53      kristaps  892:        int               type, sv, i;
1.25      kristaps  893: #define        TYPE_NONE        (0)
                    894: #define        TYPE_BODY        (1)
                    895: #define        TYPE_HEAD        (2)
1.47      kristaps  896: #define        TYPE_OHEAD       (3)
1.53      kristaps  897:        size_t            argc;
1.25      kristaps  898:        struct mdoc_node *n;
                    899:
                    900:        if (MDOC_BLOCK != mdoc->last->type)
                    901:                return(1);
                    902:
1.53      kristaps  903:        n = mdoc->last->parent->parent;
1.25      kristaps  904:
                    905:        argc = n->data.block.argc;
                    906:        type = TYPE_NONE;
1.38      kristaps  907:        sv = -1;
1.26      kristaps  908:
                    909:        /* Some types require block-head, some not. */
1.25      kristaps  910:
1.38      kristaps  911:        /* LINTED */
1.53      kristaps  912:        for (i = 0; TYPE_NONE == type && i < (int)argc; i++)
                    913:                switch (n->data.block.argv[i].arg) {
1.25      kristaps  914:                case (MDOC_Tag):
                    915:                        /* FALLTHROUGH */
                    916:                case (MDOC_Diag):
                    917:                        /* FALLTHROUGH */
                    918:                case (MDOC_Hang):
                    919:                        /* FALLTHROUGH */
                    920:                case (MDOC_Ohang):
                    921:                        /* FALLTHROUGH */
                    922:                case (MDOC_Inset):
                    923:                        type = TYPE_HEAD;
1.53      kristaps  924:                        sv = n->data.block.argv[i].arg;
1.25      kristaps  925:                        break;
                    926:                case (MDOC_Bullet):
                    927:                        /* FALLTHROUGH */
                    928:                case (MDOC_Dash):
                    929:                        /* FALLTHROUGH */
                    930:                case (MDOC_Enum):
                    931:                        /* FALLTHROUGH */
                    932:                case (MDOC_Hyphen):
                    933:                        /* FALLTHROUGH */
                    934:                case (MDOC_Item):
1.47      kristaps  935:                        type = TYPE_BODY;
1.53      kristaps  936:                        sv = n->data.block.argv[i].arg;
1.47      kristaps  937:                        break;
1.25      kristaps  938:                case (MDOC_Column):
1.47      kristaps  939:                        type = TYPE_OHEAD;
1.53      kristaps  940:                        sv = n->data.block.argv[i].arg;
1.25      kristaps  941:                        break;
                    942:                default:
                    943:                        break;
                    944:                }
                    945:
                    946:        assert(TYPE_NONE != type);
                    947:
1.47      kristaps  948:        n = mdoc->last->data.block.head;
                    949:
1.25      kristaps  950:        if (TYPE_HEAD == type) {
1.33      kristaps  951:                if (NULL == n->child)
1.53      kristaps  952:                        if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                    953:                                        "argument(s) suggested"))
1.25      kristaps  954:                                return(0);
                    955:
1.33      kristaps  956:                n = mdoc->last->data.block.body;
                    957:                if (NULL == n->child)
1.53      kristaps  958:                        if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                    959:                                        "multiline body suggested"))
1.25      kristaps  960:                                return(0);
                    961:
1.47      kristaps  962:        } else if (TYPE_BODY == type) {
                    963:                if (n->child)
1.53      kristaps  964:                        if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                    965:                                        "no argument suggested"))
1.47      kristaps  966:                                return(0);
                    967:
                    968:                n = mdoc->last->data.block.body;
                    969:                if (NULL == n->child)
1.53      kristaps  970:                        if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                    971:                                        "multiline body suggested"))
1.47      kristaps  972:                                return(0);
                    973:        } else {
                    974:                if (NULL == n->child)
1.53      kristaps  975:                        if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                    976:                                        "argument(s) suggested"))
1.47      kristaps  977:                                return(0);
                    978:
                    979:                n = mdoc->last->data.block.body;
                    980:                if (n->child)
1.53      kristaps  981:                        if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
                    982:                                        "no multiline body suggested"))
1.47      kristaps  983:                                return(0);
1.25      kristaps  984:        }
                    985:
1.47      kristaps  986:        if (MDOC_Column != sv)
1.26      kristaps  987:                return(1);
                    988:
1.38      kristaps  989:        argc = mdoc->last->parent->parent->data.block.argv->sz;
1.26      kristaps  990:        n = mdoc->last->data.block.head->child;
1.25      kristaps  991:
1.26      kristaps  992:        for (i = 0; n; n = n->next)
                    993:                i++;
                    994:
1.53      kristaps  995:        if (i == (int)argc)
1.26      kristaps  996:                return(1);
1.53      kristaps  997:
                    998:        return(mdoc_err(mdoc, "need %zu columns (have %d)", argc, i));
1.25      kristaps  999: #undef TYPE_NONE
                   1000: #undef TYPE_BODY
                   1001: #undef TYPE_HEAD
1.47      kristaps 1002: #undef TYPE_OHEAD
1.25      kristaps 1003: }
                   1004:
                   1005:
1.24      kristaps 1006: static int
1.55      kristaps 1007: post_bl(POST_ARGS)
1.24      kristaps 1008: {
1.53      kristaps 1009:        struct mdoc_node        *n;
1.24      kristaps 1010:
                   1011:        if (MDOC_BODY != mdoc->last->type)
                   1012:                return(1);
                   1013:
1.38      kristaps 1014:        /* LINTED */
1.24      kristaps 1015:        for (n = mdoc->last->child; n; n = n->next) {
                   1016:                if (MDOC_BLOCK == n->type)
1.25      kristaps 1017:                        if (MDOC_It == n->tok)
1.24      kristaps 1018:                                continue;
                   1019:                break;
                   1020:        }
1.53      kristaps 1021:
1.24      kristaps 1022:        if (NULL == n)
                   1023:                return(1);
1.53      kristaps 1024:
                   1025:        return(mdoc_nerr(mdoc, n, "bad child of parent list"));
1.24      kristaps 1026: }
                   1027:
                   1028:
1.34      kristaps 1029: static int
1.37      kristaps 1030: ebool(struct mdoc *mdoc)
1.34      kristaps 1031: {
                   1032:        struct mdoc_node *n;
                   1033:
1.38      kristaps 1034:        /* LINTED */
1.34      kristaps 1035:        for (n = mdoc->last->child; n; n = n->next) {
                   1036:                if (MDOC_TEXT != n->type)
                   1037:                        break;
                   1038:                if (xstrcmp(n->data.text.string, "on"))
                   1039:                        continue;
                   1040:                if (xstrcmp(n->data.text.string, "off"))
                   1041:                        continue;
                   1042:                break;
                   1043:        }
1.53      kristaps 1044:
1.34      kristaps 1045:        if (NULL == n)
                   1046:                return(1);
1.53      kristaps 1047:        return(mdoc_nerr(mdoc, n, "expected boolean"));
1.37      kristaps 1048: }
                   1049:
                   1050:
                   1051: static int
1.55      kristaps 1052: post_root(POST_ARGS)
1.37      kristaps 1053: {
                   1054:
1.46      kristaps 1055:        if (NULL == mdoc->first->child)
1.53      kristaps 1056:                return(mdoc_err(mdoc, "document lacks data"));
1.46      kristaps 1057:        if (SEC_PROLOGUE == mdoc->lastnamed)
1.53      kristaps 1058:                return(mdoc_err(mdoc, "document lacks prologue"));
                   1059:
1.46      kristaps 1060:        if (MDOC_BLOCK != mdoc->first->child->type)
1.54      kristaps 1061:                return(mdoc_err(mdoc, "lacking post-prologue %s",
1.53      kristaps 1062:                                        mdoc_macronames[MDOC_Sh]));
1.46      kristaps 1063:        if (MDOC_Sh != mdoc->first->child->tok)
1.54      kristaps 1064:                return(mdoc_err(mdoc, "lacking post-prologue %s",
1.53      kristaps 1065:                                        mdoc_macronames[MDOC_Sh]));
                   1066:
1.37      kristaps 1067:        return(1);
1.34      kristaps 1068: }
                   1069:
                   1070:
1.20      kristaps 1071: static int
1.55      kristaps 1072: post_sh(POST_ARGS)
1.14      kristaps 1073: {
1.46      kristaps 1074:
                   1075:        if (MDOC_HEAD == mdoc->last->type)
                   1076:                return(post_sh_head(mdoc));
                   1077:        if (MDOC_BODY == mdoc->last->type)
                   1078:                return(post_sh_body(mdoc));
1.53      kristaps 1079:
1.46      kristaps 1080:        return(1);
                   1081: }
                   1082:
                   1083:
                   1084: static int
1.55      kristaps 1085: post_sh_body(POST_ARGS)
1.46      kristaps 1086: {
                   1087:        struct mdoc_node *n;
                   1088:
                   1089:        if (SEC_NAME != mdoc->lastnamed)
                   1090:                return(1);
                   1091:
1.51      kristaps 1092:        /*
                   1093:         * Warn if the NAME section doesn't contain the `Nm' and `Nd'
                   1094:         * macros (can have multiple `Nm' and one `Nd').  Note that the
                   1095:         * children of the BODY declaration can also be "text".
                   1096:         */
                   1097:
1.46      kristaps 1098:        if (NULL == (n = mdoc->last->child))
1.54      kristaps 1099:                return(mdoc_warn(mdoc, WARN_SYNTAX,
                   1100:                                        "section should have %s and %s",
1.51      kristaps 1101:                                        mdoc_macronames[MDOC_Nm],
                   1102:                                        mdoc_macronames[MDOC_Nd]));
                   1103:
                   1104:        for ( ; n && n->next; n = n->next) {
                   1105:                if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
                   1106:                        continue;
                   1107:                if (MDOC_TEXT == n->type)
                   1108:                        continue;
1.54      kristaps 1109:                if ( ! (mdoc_nwarn(mdoc, n, WARN_SYNTAX,
                   1110:                                        "section should have %s first",
1.51      kristaps 1111:                                        mdoc_macronames[MDOC_Nm])))
                   1112:                        return(0);
                   1113:        }
                   1114:
                   1115:        if (MDOC_ELEM == n->type && MDOC_Nd == n->tok)
1.46      kristaps 1116:                return(1);
                   1117:
1.54      kristaps 1118:        return(mdoc_warn(mdoc, WARN_SYNTAX,
                   1119:                                "section should have %s last",
1.51      kristaps 1120:                                mdoc_macronames[MDOC_Nd]));
1.46      kristaps 1121: }
                   1122:
                   1123:
                   1124: static int
1.55      kristaps 1125: post_sh_head(POST_ARGS)
1.46      kristaps 1126: {
1.36      kristaps 1127:        char              buf[64];
1.21      kristaps 1128:        enum mdoc_sec     sec;
                   1129:
1.25      kristaps 1130:        assert(MDOC_Sh == mdoc->last->tok);
1.21      kristaps 1131:
1.54      kristaps 1132:        if ( ! xstrlcats(buf, mdoc->last->child, sizeof(buf)))
                   1133:                return(mdoc_err(mdoc, "argument too long"));
1.14      kristaps 1134:
1.46      kristaps 1135:        sec = mdoc_atosec(buf);
                   1136:
                   1137:        if (SEC_BODY == mdoc->lastnamed && SEC_NAME != sec)
1.54      kristaps 1138:                return(mdoc_warn(mdoc, WARN_SYNTAX,
                   1139:                                "section NAME should be first"));
1.46      kristaps 1140:        if (SEC_CUSTOM == sec)
1.21      kristaps 1141:                return(1);
1.46      kristaps 1142:        if (sec == mdoc->lastnamed)
1.54      kristaps 1143:                return(mdoc_warn(mdoc, WARN_SYNTAX,
                   1144:                                "section repeated"));
1.46      kristaps 1145:        if (sec < mdoc->lastnamed)
1.54      kristaps 1146:                return(mdoc_warn(mdoc, WARN_SYNTAX,
                   1147:                                "section out of order"));
1.46      kristaps 1148:
                   1149:        return(1);
1.11      kristaps 1150: }
                   1151:
                   1152:
1.57      kristaps 1153: static int
                   1154: post_fd(POST_ARGS)
1.11      kristaps 1155: {
1.39      kristaps 1156:
1.57      kristaps 1157:        if (SEC_SYNOPSIS == mdoc->last->sec)
1.25      kristaps 1158:                return(1);
1.57      kristaps 1159:        return(mdoc_warn(mdoc, WARN_COMPAT,
                   1160:                        "suggested only in section SYNOPSIS"));
1.11      kristaps 1161: }

CVSweb