During validation, drop .br before a text line starting with a

[mandoc.git] / man_validate.c

diff --git a/man_validate.c b/man_validate.c
index 8e2f6bee4df1b20163a64a8238d1c9290e2f0d06..806a6cdc794c9fe09313308085b4e5de614aa4b3 100644 (file)
--- a/man_validate.c
+++ b/man_validate.c
@@ -40,6 +40,7 @@
 
 typedef        void    (*v_check)(CHKARGS);
 
+static void      check_abort(CHKARGS);
 static void      check_par(CHKARGS);
 static void      check_part(CHKARGS);
 static void      check_root(CHKARGS);
@@ -48,20 +49,21 @@ static      void      check_text(CHKARGS);
 static void      post_AT(CHKARGS);
 static void      post_IP(CHKARGS);
 static void      post_OP(CHKARGS);
+static void      post_SH(CHKARGS);
 static void      post_TH(CHKARGS);
 static void      post_UC(CHKARGS);
 static void      post_UR(CHKARGS);
 static void      post_in(CHKARGS);
-static void      post_vs(CHKARGS);
 
 static const v_check man_valids[MAN_MAX - MAN_TH] = {
        post_TH,    /* TH */
-       NULL,       /* SH */
-       NULL,       /* SS */
+       post_SH,    /* SH */
+       post_SH,    /* SS */
        NULL,       /* TP */
-       check_par,  /* LP */
+       NULL,       /* TQ */
+       check_abort,/* LP */
        check_par,  /* PP */
-       check_par,  /* P */
+       check_abort,/* P */
        post_IP,    /* IP */
        NULL,       /* HP */
        NULL,       /* SM */
@@ -84,6 +86,8 @@ static        const v_check man_valids[MAN_MAX - MAN_TH] = {
        NULL,       /* PD */
        post_AT,    /* AT */
        post_in,    /* in */
+       NULL,       /* SY */
+       NULL,       /* YS */
        post_OP,    /* OP */
        NULL,       /* EX */
        NULL,       /* EE */
@@ -94,13 +98,33 @@ static      const v_check man_valids[MAN_MAX - MAN_TH] = {
 };
 
 
+/* Validate the subtree rooted at man->last. */
 void
 man_node_validate(struct roff_man *man)
 {
        struct roff_node *n;
        const v_check    *cp;
 
+       /*
+        * Translate obsolete macros such that later code
+        * does not need to look for them.
+        */
+
        n = man->last;
+       switch (n->tok) {
+       case MAN_LP:
+       case MAN_P:
+               n->tok = MAN_PP;
+               break;
+       default:
+               break;
+       }
+
+       /*
+        * Iterate over all children, recursing into each one
+        * in turn, depth-first.
+        */
+
        man->last = man->last->child;
        while (man->last != NULL) {
                man_node_validate(man);
@@ -110,6 +134,8 @@ man_node_validate(struct roff_man *man)
                        man->last = man->last->next;
        }
 
+       /* Finally validate the macro itself. */
+
        man->last = n;
        man->next = ROFF_NEXT_SIBLING;
        switch (n->type) {
@@ -125,15 +151,7 @@ man_node_validate(struct roff_man *man)
                break;
        default:
                if (n->tok < ROFF_MAX) {
-                       switch (n->tok) {
-                       case ROFF_br:
-                       case ROFF_sp:
-                               post_vs(man, n);
-                               break;
-                       default:
-                               roff_validate(man);
-                               break;
-                       }
+                       roff_validate(man);
                        break;
                }
                assert(n->tok >= MAN_TH && n->tok < MAN_MAX);
@@ -179,6 +197,12 @@ check_root(CHKARGS)
                    "(OpenBSD)" : "(NetBSD)");
 }
 
+static void
+check_abort(CHKARGS)
+{
+       abort();
+}
+
 static void
 check_text(CHKARGS)
 {
@@ -207,6 +231,42 @@ post_OP(CHKARGS)
        }
 }
 
+static void
+post_SH(CHKARGS)
+{
+       struct roff_node        *nc;
+
+       if (n->type != ROFFT_BODY || (nc = n->child) == NULL)
+               return;
+
+       if (nc->tok == MAN_PP && nc->body->child != NULL) {
+               while (nc->body->last != NULL) {
+                       man->next = ROFF_NEXT_CHILD;
+                       roff_node_relink(man, nc->body->last);
+                       man->last = n;
+               }
+       }
+
+       if (nc->tok == MAN_PP || nc->tok == ROFF_sp || nc->tok == ROFF_br) {
+               mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse,
+                   nc->line, nc->pos, "%s after %s",
+                   roff_name[nc->tok], roff_name[n->tok]);
+               roff_node_delete(man, nc);
+       }
+
+       /*
+        * Trailing PP is empty, so it is deleted by check_par().
+        * Trailing sp is significant.
+        */
+
+       if ((nc = n->last) != NULL && nc->tok == ROFF_br) {
+               mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse,
+                   nc->line, nc->pos, "%s at the end of %s",
+                   roff_name[nc->tok], roff_name[n->tok]);
+               roff_node_delete(man, nc);
+       }
+}
+
 static void
 post_UR(CHKARGS)
 {
@@ -235,6 +295,14 @@ check_par(CHKARGS)
                        roff_node_delete(man, n);
                break;
        case ROFFT_BODY:
+               if (n->child != NULL &&
+                   (n->child->tok == ROFF_sp || n->child->tok == ROFF_br)) {
+                       mandoc_vmsg(MANDOCERR_PAR_SKIP,
+                           man->parse, n->child->line, n->child->pos,
+                           "%s after %s", roff_name[n->child->tok],
+                           roff_name[n->tok]);
+                       roff_node_delete(man, n->child);
+               }
                if (n->child == NULL)
                        mandoc_vmsg(MANDOCERR_PAR_SKIP,
                            man->parse, n->line, n->pos,
@@ -462,32 +530,3 @@ post_in(CHKARGS)
        free(n->child->string);
        n->child->string = s;
 }
-
-static void
-post_vs(CHKARGS)
-{
-
-       if (NULL != n->prev)
-               return;
-
-       switch (n->parent->tok) {
-       case MAN_SH:
-       case MAN_SS:
-       case MAN_PP:
-       case MAN_LP:
-       case MAN_P:
-               mandoc_vmsg(MANDOCERR_PAR_SKIP, man->parse, n->line, n->pos,
-                   "%s after %s", roff_name[n->tok],
-                   roff_name[n->parent->tok]);
-               /* FALLTHROUGH */
-       case TOKEN_NONE:
-               /*
-                * Don't warn about this because it occurs in pod2man
-                * and would cause considerable (unfixable) warnage.
-                */
-               roff_node_delete(man, n);
-               break;
-       default:
-               break;
-       }
-}