]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_validate.c
shut up about tabs in SYNOPSIS .Fd lines, there is no good way to avoid them
[mandoc.git] / mdoc_validate.c
index 417e21615c43f22f66b3c852507e885e3fda974e..f37e4c3734fd63218497ed6cc738936f35c0989f 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_validate.c,v 1.268 2015/02/04 18:03:47 schwarze Exp $ */
+/*     $Id: mdoc_validate.c,v 1.279 2015/02/14 13:23:57 schwarze Exp $ */
 /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010-2015 Ingo Schwarze <schwarze@openbsd.org>
@@ -56,8 +56,6 @@ struct        valids {
        v_post   post;
 };
 
-static void     check_count(struct mdoc *, enum mdoc_type,
-                       enum check_ineq, int);
 static void     check_text(struct mdoc *, int, int, char *);
 static void     check_argv(struct mdoc *,
                        struct mdoc_node *, struct mdoc_argv *);
@@ -67,11 +65,6 @@ static       enum mdoc_sec   a2sec(const char *);
 static size_t          macro2len(enum mdoct);
 static void     rewrite_macro2len(char **);
 
-static void     bwarn_ge1(POST_ARGS);
-static void     ewarn_eq1(POST_ARGS);
-static void     ewarn_ge1(POST_ARGS);
-static void     hwarn_eq0(POST_ARGS);
-
 static void     post_an(POST_ARGS);
 static void     post_at(POST_ARGS);
 static void     post_bf(POST_ARGS);
@@ -94,7 +87,6 @@ static        void     post_fn(POST_ARGS);
 static void     post_fname(POST_ARGS);
 static void     post_fo(POST_ARGS);
 static void     post_hyph(POST_ARGS);
-static void     post_hyphtext(POST_ARGS);
 static void     post_ignpar(POST_ARGS);
 static void     post_it(POST_ARGS);
 static void     post_lb(POST_ARGS);
@@ -152,12 +144,12 @@ static    const struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, NULL },                         /* Ev */
        { pre_std, post_ex },                   /* Ex */
        { NULL, post_fa },                      /* Fa */
-       { NULL, ewarn_ge1 },                    /* Fd */
+       { NULL, NULL },                         /* Fd */
        { NULL, NULL },                         /* Fl */
        { NULL, post_fn },                      /* Fn */
        { NULL, NULL },                         /* Ft */
        { NULL, NULL },                         /* Ic */
-       { NULL, ewarn_eq1 },                    /* In */
+       { NULL, NULL },                         /* In */
        { NULL, post_defaults },                /* Li */
        { NULL, post_nd },                      /* Nd */
        { NULL, post_nm },                      /* Nm */
@@ -168,18 +160,18 @@ static    const struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, post_st },                      /* St */
        { NULL, NULL },                         /* Va */
        { NULL, post_vt },                      /* Vt */
-       { NULL, ewarn_ge1 },                    /* Xr */
-       { NULL, ewarn_ge1 },                    /* %A */
-       { NULL, post_hyphtext },                /* %B */ /* FIXME: can be used outside Rs/Re. */
-       { NULL, ewarn_ge1 },                    /* %D */
-       { NULL, ewarn_ge1 },                    /* %I */
-       { NULL, ewarn_ge1 },                    /* %J */
-       { NULL, post_hyphtext },                /* %N */
-       { NULL, post_hyphtext },                /* %O */
-       { NULL, ewarn_ge1 },                    /* %P */
-       { NULL, post_hyphtext },                /* %R */
-       { NULL, post_hyphtext },                /* %T */ /* FIXME: can be used outside Rs/Re. */
-       { NULL, ewarn_ge1 },                    /* %V */
+       { NULL, NULL },                         /* Xr */
+       { NULL, NULL },                         /* %A */
+       { NULL, post_hyph },                    /* %B */ /* FIXME: can be used outside Rs/Re. */
+       { NULL, NULL },                         /* %D */
+       { NULL, NULL },                         /* %I */
+       { NULL, NULL },                         /* %J */
+       { NULL, post_hyph },                    /* %N */
+       { NULL, post_hyph },                    /* %O */
+       { NULL, NULL },                         /* %P */
+       { NULL, post_hyph },                    /* %R */
+       { NULL, post_hyph },                    /* %T */ /* FIXME: can be used outside Rs/Re. */
+       { NULL, NULL },                         /* %V */
        { NULL, NULL },                         /* Ac */
        { NULL, NULL },                         /* Ao */
        { NULL, NULL },                         /* Aq */
@@ -241,14 +233,14 @@ static    const struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, NULL },                         /* Brq */
        { NULL, NULL },                         /* Bro */
        { NULL, NULL },                         /* Brc */
-       { NULL, ewarn_ge1 },                    /* %C */
+       { NULL, NULL },                         /* %C */
        { pre_obsolete, post_es },              /* Es */
        { pre_obsolete, post_en },              /* En */
        { NULL, NULL },                         /* Dx */
-       { NULL, ewarn_ge1 },                    /* %Q */
+       { NULL, NULL },                         /* %Q */
        { NULL, post_par },                     /* br */
        { NULL, post_par },                     /* sp */
-       { NULL, ewarn_eq1 },                    /* %U */
+       { NULL, NULL },                         /* %U */
        { NULL, NULL },                         /* Ta */
        { NULL, NULL },                         /* ll */
 };
@@ -306,7 +298,8 @@ mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n)
 
        switch (n->type) {
        case MDOC_TEXT:
-               check_text(mdoc, n->line, n->pos, n->string);
+               if (n->sec != SEC_SYNOPSIS || n->parent->tok != MDOC_Fd)
+                       check_text(mdoc, n->line, n->pos, n->string);
                /* FALLTHROUGH */
        case MDOC_TBL:
                /* FALLTHROUGH */
@@ -333,7 +326,7 @@ mdoc_valid_post(struct mdoc *mdoc)
        n = mdoc->last;
        if (n->flags & MDOC_VALID)
                return;
-       n->flags |= MDOC_VALID;
+       n->flags |= MDOC_VALID | MDOC_ENDED;
 
        switch (n->type) {
        case MDOC_TEXT:
@@ -367,65 +360,6 @@ mdoc_valid_post(struct mdoc *mdoc)
        }
 }
 
-static void
-check_count(struct mdoc *mdoc, enum mdoc_type type,
-       enum check_ineq ineq, int val)
-{
-       const char      *p;
-
-       if (mdoc->last->type != type)
-               return;
-
-       switch (ineq) {
-       case CHECK_LT:
-               p = "less than ";
-               if (mdoc->last->nchild < val)
-                       return;
-               break;
-       case CHECK_GT:
-               p = "more than ";
-               if (mdoc->last->nchild > val)
-                       return;
-               break;
-       case CHECK_EQ:
-               p = "";
-               if (val == mdoc->last->nchild)
-                       return;
-               break;
-       default:
-               abort();
-               /* NOTREACHED */
-       }
-
-       mandoc_vmsg(MANDOCERR_ARGCWARN, mdoc->parse, mdoc->last->line,
-           mdoc->last->pos, "want %s%d children (have %d)",
-           p, val, mdoc->last->nchild);
-}
-
-static void
-bwarn_ge1(POST_ARGS)
-{
-       check_count(mdoc, MDOC_BODY, CHECK_GT, 0);
-}
-
-static void
-ewarn_eq1(POST_ARGS)
-{
-       check_count(mdoc, MDOC_ELEM, CHECK_EQ, 1);
-}
-
-static void
-ewarn_ge1(POST_ARGS)
-{
-       check_count(mdoc, MDOC_ELEM, CHECK_GT, 0);
-}
-
-static void
-hwarn_eq0(POST_ARGS)
-{
-       check_count(mdoc, MDOC_HEAD, CHECK_EQ, 0);
-}
-
 static void
 check_args(struct mdoc *mdoc, struct mdoc_node *n)
 {
@@ -483,24 +417,13 @@ pre_display(PRE_ARGS)
 static void
 pre_bl(PRE_ARGS)
 {
-       struct mdoc_node *np;
        struct mdoc_argv *argv, *wa;
        int               i;
        enum mdocargt     mdoclt;
        enum mdoc_list    lt;
 
-       if (MDOC_BLOCK != n->type) {
-               if (ENDBODY_NOT != n->end) {
-                       assert(n->pending);
-                       np = n->pending->parent;
-               } else
-                       np = n->parent;
-
-               assert(np);
-               assert(MDOC_BLOCK == np->type);
-               assert(MDOC_Bl == np->tok);
+       if (n->type != MDOC_BLOCK)
                return;
-       }
 
        /*
         * First figure out which kind of list to use: bind ourselves to
@@ -676,25 +599,14 @@ pre_bl(PRE_ARGS)
 static void
 pre_bd(PRE_ARGS)
 {
-       struct mdoc_node *np;
        struct mdoc_argv *argv;
        int               i;
        enum mdoc_disp    dt;
 
        pre_literal(mdoc, n);
 
-       if (MDOC_BLOCK != n->type) {
-               if (ENDBODY_NOT != n->end) {
-                       assert(n->pending);
-                       np = n->pending->parent;
-               } else
-                       np = n->parent;
-
-               assert(np);
-               assert(MDOC_BLOCK == np->type);
-               assert(MDOC_Bd == np->tok);
+       if (n->type != MDOC_BLOCK)
                return;
-       }
 
        for (i = 0; n->args && i < (int)n->args->argc; i++) {
                argv = n->args->argv + i;
@@ -864,22 +776,10 @@ post_bf(POST_ARGS)
         * element, which contains the goods.
         */
 
-       if (MDOC_HEAD != mdoc->last->type) {
-               if (ENDBODY_NOT != mdoc->last->end) {
-                       assert(mdoc->last->pending);
-                       np = mdoc->last->pending->parent->head;
-               } else if (MDOC_BLOCK != mdoc->last->type) {
-                       np = mdoc->last->parent->head;
-               } else
-                       np = mdoc->last->head;
-
-               assert(np);
-               assert(MDOC_HEAD == np->type);
-               assert(MDOC_Bf == np->tok);
+       np = mdoc->last;
+       if (MDOC_HEAD != np->type)
                return;
-       }
 
-       np = mdoc->last;
        assert(MDOC_BLOCK == np->parent->type);
        assert(MDOC_Bf == np->parent->tok);
 
@@ -934,7 +834,6 @@ post_lb(POST_ARGS)
        const char              *stdlibname;
        char                    *libname;
 
-       check_count(mdoc, MDOC_ELEM, CHECK_EQ, 1);
        n = mdoc->last->child;
        assert(MDOC_TEXT == n->type);
 
@@ -987,11 +886,27 @@ post_fn(POST_ARGS)
 static void
 post_fo(POST_ARGS)
 {
+       const struct mdoc_node  *n;
+
+       n = mdoc->last;
 
-       check_count(mdoc, MDOC_HEAD, CHECK_EQ, 1);
-       bwarn_ge1(mdoc);
-       if (mdoc->last->type == MDOC_HEAD && mdoc->last->nchild)
-               post_fname(mdoc);
+       if (n->type != MDOC_HEAD)
+               return;
+
+       if (n->child == NULL) {
+               mandoc_msg(MANDOCERR_FO_NOHEAD, mdoc->parse,
+                   n->line, n->pos, "Fo");
+               return;
+       }
+       if (n->child != n->last) {
+               mandoc_vmsg(MANDOCERR_ARG_EXCESS, mdoc->parse,
+                   n->child->next->line, n->child->next->pos,
+                   "Fo ... %s", n->child->next->string);
+               while (n->child != n->last)
+                       mdoc_node_delete(mdoc, n->last);
+       }
+
+       post_fname(mdoc);
 }
 
 static void
@@ -1079,28 +994,40 @@ post_nd(POST_ARGS)
 static void
 post_d1(POST_ARGS)
 {
+       struct mdoc_node        *n;
+
+       n = mdoc->last;
+
+       if (n->type != MDOC_BODY)
+               return;
+
+       if (n->child == NULL)
+               mandoc_msg(MANDOCERR_BLK_EMPTY, mdoc->parse,
+                   n->line, n->pos, "D1");
 
-       bwarn_ge1(mdoc);
        post_hyph(mdoc);
 }
 
 static void
 post_literal(POST_ARGS)
 {
+       struct mdoc_node        *n;
 
-       if (mdoc->last->tok == MDOC_Bd)
-               hwarn_eq0(mdoc);
-       bwarn_ge1(mdoc);
+       n = mdoc->last;
 
-       /*
-        * The `Dl' (note "el" not "one") and `Bd' macros unset the
-        * MDOC_LITERAL flag as they leave.  Note that `Bd' only sets
-        * this in literal mode, but it doesn't hurt to just switch it
-        * off in general since displays can't be nested.
-        */
+       if (n->type != MDOC_BODY)
+               return;
+
+       if (n->child == NULL)
+               mandoc_msg(MANDOCERR_BLK_EMPTY, mdoc->parse,
+                   n->line, n->pos, mdoc_macronames[n->tok]);
 
-       if (MDOC_BODY == mdoc->last->type)
-               mdoc->flags &= ~MDOC_LITERAL;
+       if (n->tok == MDOC_Bd &&
+           n->norm->Bd.type != DISP_literal &&
+           n->norm->Bd.type != DISP_unfilled)
+               return;
+
+       mdoc->flags &= ~MDOC_LITERAL;
 }
 
 static void
@@ -1174,14 +1101,17 @@ post_at(POST_ARGS)
 static void
 post_an(POST_ARGS)
 {
-       struct mdoc_node *np;
+       struct mdoc_node *np, *nch;
 
        np = mdoc->last;
-       if (AUTH__NONE == np->norm->An.auth) {
-               if (0 == np->child)
-                       check_count(mdoc, MDOC_ELEM, CHECK_GT, 0);
-       } else if (np->child)
-               check_count(mdoc, MDOC_ELEM, CHECK_EQ, 0);
+       nch = np->child;
+       if (np->norm->An.auth == AUTH__NONE) {
+               if (nch == NULL)
+                       mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
+                           np->line, np->pos, "An");
+       } else if (nch != NULL)
+               mandoc_vmsg(MANDOCERR_ARG_EXCESS, mdoc->parse,
+                   nch->line, nch->pos, "An ... %s", nch->string);
 }
 
 static void
@@ -1258,9 +1188,9 @@ post_it(POST_ARGS)
                                i++;
 
                if (i < cols || i > cols + 1)
-                       mandoc_vmsg(MANDOCERR_ARGCOUNT,
+                       mandoc_vmsg(MANDOCERR_BL_COL,
                            mdoc->parse, nit->line, nit->pos,
-                           "columns == %d (have %d)", cols, i);
+                           "%d columns, %d cells", cols, i);
                break;
        default:
                abort();
@@ -1414,13 +1344,21 @@ post_bl_block_tag(POST_ARGS)
 static void
 post_bl_head(POST_ARGS)
 {
-       struct mdoc_node *np, *nn, *nnp;
+       struct mdoc_node *nbl, *nh, *nch, *nnext;
        struct mdoc_argv *argv;
        int               i, j;
 
-       if (LIST_column != mdoc->last->norm->Bl.type) {
-               /* FIXME: this should be ERROR class... */
-               hwarn_eq0(mdoc);
+       nh = mdoc->last;
+
+       if (nh->norm->Bl.type != LIST_column) {
+               if ((nch = nh->child) == NULL)
+                       return;
+               mandoc_vmsg(MANDOCERR_ARG_EXCESS, mdoc->parse,
+                   nch->line, nch->pos, "Bl ... %s", nch->string);
+               while (nch != NULL) {
+                       mdoc_node_delete(mdoc, nch);
+                       nch = nh->child;
+               }
                return;
        }
 
@@ -1430,17 +1368,15 @@ post_bl_head(POST_ARGS)
         * lists where they're argument values following -column.
         */
 
-       if (mdoc->last->child == NULL)
+       if (nh->child == NULL)
                return;
 
-       np = mdoc->last->parent;
-       assert(np->args);
-
-       for (j = 0; j < (int)np->args->argc; j++)
-               if (MDOC_Column == np->args->argv[j].arg)
+       nbl = nh->parent;
+       for (j = 0; j < (int)nbl->args->argc; j++)
+               if (nbl->args->argv[j].arg == MDOC_Column)
                        break;
 
-       assert(j < (int)np->args->argc);
+       assert(j < (int)nbl->args->argc);
 
        /*
         * Accommodate for new-style groff column syntax.  Shuffle the
@@ -1448,25 +1384,23 @@ post_bl_head(POST_ARGS)
         * column field.  Then, delete the head children.
         */
 
-       argv = np->args->argv + j;
+       argv = nbl->args->argv + j;
        i = argv->sz;
-       argv->sz += mdoc->last->nchild;
+       argv->sz += nh->nchild;
        argv->value = mandoc_reallocarray(argv->value,
            argv->sz, sizeof(char *));
 
-       mdoc->last->norm->Bl.ncols = argv->sz;
-       mdoc->last->norm->Bl.cols = (void *)argv->value;
+       nh->norm->Bl.ncols = argv->sz;
+       nh->norm->Bl.cols = (void *)argv->value;
 
-       for (nn = mdoc->last->child; nn; i++) {
-               argv->value[i] = nn->string;
-               nn->string = NULL;
-               nnp = nn;
-               nn = nn->next;
-               mdoc_node_delete(NULL, nnp);
+       for (nch = nh->child; nch != NULL; nch = nnext) {
+               argv->value[i++] = nch->string;
+               nch->string = NULL;
+               nnext = nch->next;
+               mdoc_node_delete(NULL, nch);
        }
-
-       mdoc->last->nchild = 0;
-       mdoc->last->child = NULL;
+       nh->nchild = 0;
+       nh->child = NULL;
 }
 
 static void
@@ -1490,10 +1424,13 @@ post_bl(POST_ARGS)
                return;
        }
 
-       bwarn_ge1(mdoc);
-
        nchild = nbody->child;
-       while (NULL != nchild) {
+       if (nchild == NULL) {
+               mandoc_msg(MANDOCERR_BLK_EMPTY, mdoc->parse,
+                   nbody->line, nbody->pos, "Bl");
+               return;
+       }
+       while (nchild != NULL) {
                if (nchild->tok == MDOC_It ||
                    (nchild->tok == MDOC_Sm &&
                     nchild->next != NULL &&
@@ -1552,9 +1489,15 @@ post_bl(POST_ARGS)
 static void
 post_bk(POST_ARGS)
 {
+       struct mdoc_node        *n;
 
-       hwarn_eq0(mdoc);
-       bwarn_ge1(mdoc);
+       n = mdoc->last;
+
+       if (n->type == MDOC_BLOCK && n->body->child == NULL) {
+               mandoc_msg(MANDOCERR_BLK_EMPTY,
+                   mdoc->parse, n->line, n->pos, "Bk");
+               mdoc_node_delete(mdoc, n);
+       }
 }
 
 static void
@@ -1636,13 +1579,6 @@ post_st(POST_ARGS)
        n = mdoc->last;
        nch = n->child;
 
-       if (NULL == nch) {
-               mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse,
-                   n->line, n->pos, mdoc_macronames[n->tok]);
-               mdoc_node_delete(mdoc, n);
-               return;
-       }
-
        assert(MDOC_TEXT == nch->type);
 
        if (NULL == (p = mdoc_a2st(nch->string))) {
@@ -1752,47 +1688,23 @@ post_rs(POST_ARGS)
 static void
 post_hyph(POST_ARGS)
 {
-       struct mdoc_node        *n, *nch;
+       struct mdoc_node        *nch;
        char                    *cp;
 
-       n = mdoc->last;
-       switch (n->type) {
-       case MDOC_HEAD:
-               if (MDOC_Sh == n->tok || MDOC_Ss == n->tok)
-                       break;
-               return;
-       case MDOC_BODY:
-               if (MDOC_D1 == n->tok || MDOC_Nd == n->tok)
-                       break;
-               return;
-       case MDOC_ELEM:
-               break;
-       default:
-               return;
-       }
-
-       for (nch = n->child; nch; nch = nch->next) {
-               if (MDOC_TEXT != nch->type)
+       for (nch = mdoc->last->child; nch != NULL; nch = nch->next) {
+               if (nch->type != MDOC_TEXT)
                        continue;
                cp = nch->string;
-               if ('\0' == *cp)
+               if (*cp == '\0')
                        continue;
-               while ('\0' != *(++cp))
-                       if ('-' == *cp &&
+               while (*(++cp) != '\0')
+                       if (*cp == '-' &&
                            isalpha((unsigned char)cp[-1]) &&
                            isalpha((unsigned char)cp[1]))
                                *cp = ASCII_HYPH;
        }
 }
 
-static void
-post_hyphtext(POST_ARGS)
-{
-
-       ewarn_ge1(mdoc);
-       post_hyph(mdoc);
-}
-
 static void
 post_ns(POST_ARGS)
 {
@@ -1870,7 +1782,7 @@ static void
 post_sh_see_also(POST_ARGS)
 {
        const struct mdoc_node  *n;
-       const char              *name, *sec;
+       const char              *name, *sec;
        const char              *lastname, *lastsec, *lastpunct;
        int                      cmp;
 
@@ -2072,11 +1984,15 @@ post_ignpar(POST_ARGS)
 {
        struct mdoc_node *np;
 
-       check_count(mdoc, MDOC_HEAD, CHECK_GT, 0);
-       post_hyph(mdoc);
-
-       if (MDOC_BODY != mdoc->last->type)
+       switch (mdoc->last->type) {
+       case MDOC_HEAD:
+               post_hyph(mdoc);
                return;
+       case MDOC_BODY:
+               break;
+       default:
+               return;
+       }
 
        if (NULL != (np = mdoc->last->child))
                if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) {
@@ -2134,14 +2050,17 @@ post_par(POST_ARGS)
 {
        struct mdoc_node *np;
 
-       if (mdoc->last->tok == MDOC_sp)
-               check_count(mdoc, MDOC_ELEM, CHECK_LT, 2);
-       else
-               check_count(mdoc, MDOC_ELEM, CHECK_EQ, 0);
+       np = mdoc->last;
 
-       if (MDOC_ELEM != mdoc->last->type &&
-           MDOC_BLOCK != mdoc->last->type)
-               return;
+       if (np->tok == MDOC_sp) {
+               if (np->nchild > 1)
+                       mandoc_vmsg(MANDOCERR_ARG_EXCESS, mdoc->parse,
+                           np->child->next->line, np->child->next->pos,
+                           "sp ... %s", np->child->next->string);
+       } else if (np->child != NULL)
+               mandoc_vmsg(MANDOCERR_ARG_SKIP,
+                   mdoc->parse, np->line, np->pos, "%s %s",
+                   mdoc_macronames[np->tok], np->child->string);
 
        if (NULL == (np = mdoc->last->prev)) {
                np = mdoc->last->parent;